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: <api-key>'
import requests

url = "https://api.promptlayer.com/api/public/v2/requests/suggestions"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.promptlayer.com/api/public/v2/requests/suggestions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.promptlayer.com/api/public/v2/requests/suggestions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.promptlayer.com/api/public/v2/requests/suggestions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.promptlayer.com/api/public/v2/requests/suggestions")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.promptlayer.com/api/public/v2/requests/suggestions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "values": [
    "production",
    "staging",
    "prod-v2"
  ]
}
{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}
{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
{
  "success": false,
  "message": "Rate limit exceeded. Please retry later."
}
Get autocomplete suggestions for request log fields. Use this endpoint to power search UIs, discover values in your logs, or scope suggestions with the same filters used by request-log search.

​
Behavior Notes

  • This endpoint is rate limited to 10 requests per minute.
  • filter_group uses the same JSON-encoded structured filter syntax as Search Request Logs.
  • Fields that return nested values require metadata_key to identify the nested key.

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
field
enum<string>
required

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

Autocomplete suggestions.

​
success
enum<boolean>
required
Available options:
true
​
values
string[]
required

Suggested values for the requested field.