Saltar al contenido principal
POST
Inspeccionar un endpoint
Usa input_schema para preparar tu solicitud y revisar el Price antes de ejecutarla. Guarda endpoint_version para el Run; no bloquea el Price. Para Endpoints síncronos, configura el tiempo de espera del cliente por encima de timeout_ms.

Cuerpo

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

Seleccione una versión compatible del endpoint, incluida una anterior, u omita este campo para usar la predeterminada. Las versiones no disponibles o retiradas devuelven 409.

Rango requerido: x > 0
task_id
string | null

La tarea a la que pertenece esta inspección, proveniente de una respuesta de búsqueda del catálogo. Se acepta cualquier cadena estable.

metadata

Campos de seguimiento opcionales, devueltos en el Run y disponibles como filtros. Nunca se envían al proveedor de datos ni afectan al enrutamiento, al Price ni a la idempotencia.

  • Hasta 20 claves: letras minúsculas, dígitos y guiones bajos; deben comenzar por una letra y tener como máximo 40 caracteres.
  • Valores: cadenas de 1 a 500 caracteres.
  • user_id: el ID opaco de su usuario final, nunca su dirección de correo electrónico ni su nombre.

Las entradas no válidas se descartan por completo, no se truncan. La solicitud continúa y el Run devuelve los campos que se almacenaron.

Respuesta

Éxito

provider
string
requerido
Pattern: ^[a-z0-9][a-z0-9-]*$
provider_label
string
requerido

El nombre de marca del proveedor de datos, para mostrarlo: "People Data Labs" para el proveedor de datos "pdl". La identidad permanece en provider: ese es el valor que usan Run e inspect, y este nunca se devuelve.

endpoint
string
requerido
Pattern: ^\/.+$
endpoint_version
integer
requerido

Versión compatible del endpoint. Las actualizaciones compatibles mantienen esta versión.

name
string
requerido
description
string
requerido
tags
string[]
requerido
price
object
requerido

Price y reglas de cobro actuales. El Price puede cambiar sin que cambie la versión del endpoint. Los Runs nuevos usan el Price vigente en el momento de admisión; los Runs aceptados conservan ese Price.

run_mode
enum<string>
requerido
Opciones disponibles:
sync,
async
method
enum<string>
requerido
Opciones disponibles:
GET,
POST,
PUT,
PATCH,
DELETE,
HEAD
input_schema
object
requerido

JSON Schema nativo del proveedor de datos para la entrada de Run.

output_schema
object | null
requerido

JSON Schema para una salida correcta. Es null cuando no hay un esquema fiable disponible; las respuestas de ejemplo no definen un esquema.

output_schema_source
enum<string> | null
requerido

Quién define el esquema de salida: el proveedor de datos o Glasser. Es null cuando output_schema es null.

Opciones disponibles:
provider,
glasser
sample_input
object
requerido

Entrada de ejemplo. Adáptela a su solicitud y valídela con input_schema.

doc_url
string | null
requerido

Enlace a la documentación del proveedor de datos, cuando esté disponible.

timeout_ms
integer | null

Para los endpoints síncronos, el tiempo máximo, en milisegundos, desde una solicitud de Run hasta su respuesta terminal. Configure el tiempo de espera de su cliente HTTP por encima de este valor.

Rango requerido: x > 0
client
object