Skip to main content
GET
/
api
/
public
/
v2
/
requests
/
suggestions
Search Request Suggestions
curl --request GET \
  --url https://api.promptlayer.com/api/public/v2/requests/suggestions \
  --header 'X-API-KEY: <x-api-key>'
{
  "success": true,
  "values": [
    "<unknown>"
  ]
}
Get possible values for a given request log field, optionally filtered by a prefix. This is useful for:
  • Search UIs: Power autocomplete dropdowns for search fields
  • Discovery: Find which engines, tags, metadata keys, or other values exist in your logs
  • Scoped suggestions: Narrow suggestions to requests matching a filter group

​
Authentication

This endpoint requires API key authentication via the X-API-KEY header.
This endpoint is rate limited to 10 requests per minute.

​
Parameters

​
field (required)

The request log field to get suggestions for. Available fields:
FieldDescription
engineModel names used in requests
provider_typeLLM providers (e.g. openai, anthropic)
prompt_idPrompt template IDs
promptPrompt template names (use prompt_id param to scope to a specific prompt)
tagsTags attached to requests
metadata_keysMetadata key names present in requests
statusRequest statuses (e.g. success, error)
tool_namesTool names used in requests
output_keysKeys present in flattened output
input_variable_keysInput variable key names
metadata_valuesValues for a specific metadata key (requires metadata_key param)
output_valuesValues for a specific output key (requires metadata_key param)
input_variable_valuesValues for a specific input variable key (requires metadata_key param)

​
prefix (optional)

A case-insensitive prefix string to filter suggestions. For example, prefix=gpt would return engines starting with “gpt”.

​
metadata_key (optional)

Required when field is metadata_values, output_values, or input_variable_values. Specifies which nested key to retrieve values for.

​
prompt_id (optional)

Filter suggestions to a specific prompt template. Only used when field is prompt.

​
filter_group (optional)

A JSON-encoded filter group to scope suggestions to matching requests. Uses the same filter group syntax as the Search Request Logs endpoint.

​
Examples

​
Get available engines

curl -G https://api.promptlayer.com/api/public/v2/requests/suggestions \
  -H "X-API-KEY: your_api_key" \
  -d "field=engine"

​
Autocomplete tags with prefix

curl -G https://api.promptlayer.com/api/public/v2/requests/suggestions \
  -H "X-API-KEY: your_api_key" \
  -d "field=tags" \
  -d "prefix=prod"

​
Get metadata values for a specific key

curl -G https://api.promptlayer.com/api/public/v2/requests/suggestions \
  -H "X-API-KEY: your_api_key" \
  -d "field=metadata_values" \
  -d "metadata_key=user_id" \
  -d "prefix=customer"

​
Scoped suggestions with filter group

curl -G https://api.promptlayer.com/api/public/v2/requests/suggestions \
  -H "X-API-KEY: your_api_key" \
  -d "field=tags" \
  --data-urlencode 'filter_group={"logic":"AND","filters":[{"field":"engine","operator":"is","value":"gpt-4o"}]}'

​
Response

{
  "success": true,
  "values": [
    "production",
    "staging",
    "prod-v2"
  ]
}

Headers

​
X-API-KEY
string
required

API key for authentication.

Query Parameters

​
field
enum<string>
required

The request log field to get suggestions for.

Available options:
engine,
provider_type,
prompt_id,
prompt,
tags,
metadata_keys,
status,
tool_names,
output_keys,
input_variable_keys,
metadata_values,
output_values,
input_variable_values
​
prefix
string

Case-insensitive prefix to filter suggestions.

​
metadata_key
string

Required when field is metadata_values, output_values, or input_variable_values. Specifies which key to get values for.

​
prompt_id
integer

Filter suggestions to a specific prompt template (only used when field is prompt).

Required range: x >= 1
​
filter_group
string

JSON-encoded filter group to scope suggestions to matching requests.

Response

List of suggestion values.

​
success
boolean
​
values
any[]

List of suggestion values matching the query.