Pular para o conteúdo principal
POST
Pesquisar endpoints executáveis
Escolha um candidato e inspecione-o antes de executá-lo. Se os resultados não forem adequados, tente palavras-chave diferentes; pontuações baixas ou a última página não provam que uma capacidade esteja indisponível.

Corpo

application/json
use_case
string
obrigatório

Obrigatório em toda busca. O caso de uso por trás desta busca: o que o usuário pediu, nas próprias palavras, incluindo o assunto — a empresa, o domínio, o ticker, o local ou o tópico. Encurte uma solicitação longa em vez de reescrevê-la.

Minimum string length: 1
query
string | null

Palavras-chave que descrevem os dados necessários. Omita ou deixe vazio para navegar por todos os endpoints permitidos pela Policy da sua Key.

limit
integer | null

Máximo de resultados por página. Padrão: 5; máximo: 20.

Intervalo obrigatório: 1 <= x <= 20
cursor
string | null

O next_cursor da resposta anterior. Use a mesma consulta; um cursor de outra consulta retorna 400.

task_id
string | null

A tarefa à qual esta busca pertence. Uma busca sem task_id inicia uma nova tarefa. A resposta retorna o task_id. Envie-o em todas as buscas, inspeções e execuções posteriores do mesmo trabalho. Qualquer string estável é aceita.

metadata

Campos de rastreamento opcionais, retornados no Run e disponíveis como filtros. Eles nunca são enviados ao provedor de dados nem afetam o roteamento, o preço ou a idempotência.

  • Até 20 chaves: letras minúsculas, dígitos e sublinhados; devem começar com uma letra; no máximo 40 caracteres.
  • Valores: strings de 1 a 500 caracteres.
  • user_id: o ID opaco do seu usuário final, nunca o endereço de e-mail ou o nome.

Entradas inválidas são descartadas por inteiro, não truncadas. A solicitação continua, e o Run retorna os campos armazenados.

Resposta

Sucesso

data
object[]
obrigatório

Resumos de endpoints classificados por relevância e filtrados pela Policy da sua Key. O Price não afeta a classificação.

next_cursor
string | null
obrigatório

Envie este valor como cursor para obter a próxima página. Null significa que não há mais páginas.

total
integer
obrigatório

Número total de candidatos classificados em todas as páginas.

Intervalo obrigatório: x >= 0
task_id
string
obrigatório

A task à qual esta pesquisa foi registrada — a que você enviou ou uma recém-criada, caso não tenha enviado nenhuma. Envie-a novamente em todas as chamadas posteriores de search, inspect e run para o mesmo trabalho.

client
object