Pular para o conteúdo principal
POST
Inspecionar um endpoint
Use input_schema para preparar sua solicitação e revisar o Price antes de executá-la. Salve endpoint_version para o Run; ele não bloqueia o Price. Para Endpoints síncronos, configure o timeout do cliente acima de timeout_ms.

Corpo

application/json
provider
string
obrigatório
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
obrigatório
Pattern: ^\/.+$
endpoint_version
integer | null

Selecione uma versão compatível do endpoint, inclusive uma versão anterior, ou omita-a para usar o padrão. Versões indisponíveis ou retiradas retornam 409.

Intervalo obrigatório: x > 0
task_id
string | null

A tarefa à qual esta inspeção pertence, obtida de uma resposta de busca do catálogo. 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

provider
string
obrigatório
Pattern: ^[a-z0-9][a-z0-9-]*$
provider_label
string
obrigatório

O nome da marca do provedor de dados, para exibição: "People Data Labs" para o provedor "pdl". A identidade permanece em provider — esse é o valor usado por Run e inspect, e este nunca é enviado de volta.

endpoint
string
obrigatório
Pattern: ^\/.+$
endpoint_version
integer
obrigatório

Versão compatível do endpoint. Atualizações compatíveis mantêm esta versão.

name
string
obrigatório
description
string
obrigatório
tags
string[]
obrigatório
price
object
obrigatório

Preço atual e regras de cobrança. O preço pode mudar sem alteração da versão do endpoint. Novos Runs usam o preço vigente na admissão; Runs aceitos mantêm esse preço.

run_mode
enum<string>
obrigatório
Opções disponíveis:
sync,
async
method
enum<string>
obrigatório
Opções disponíveis:
GET,
POST,
PUT,
PATCH,
DELETE,
HEAD
input_schema
object
obrigatório

JSON Schema nativo do provedor de dados para a entrada do Run.

output_schema
object | null
obrigatório

JSON Schema para uma saída bem-sucedida. Nulo quando não há um esquema confiável disponível; respostas de exemplo não definem um esquema.

output_schema_source
enum<string> | null
obrigatório

Quem define o esquema de saída: o provedor de dados ou o Glasser. Nulo quando output_schema é nulo.

Opções disponíveis:
provider,
glasser
sample_input
object
obrigatório

Entrada de exemplo. Ajuste-a à sua solicitação e valide-a em relação a input_schema.

doc_url
string | null
obrigatório

Link para a documentação do provedor de dados, quando disponível.

timeout_ms
integer | null

Para endpoints síncronos, o tempo máximo, em milissegundos, entre uma solicitação de Run e sua resposta terminal. Defina o tempo limite do seu cliente HTTP acima desse valor.

Intervalo obrigatório: x > 0
client
object