Skip to main content
POST
Inspect an Endpoint
Use input_schema to prepare your request and review the Price before running it. Save endpoint_version for the Run; it does not lock the Price. For sync Endpoints, set your client timeout above timeout_ms.

Body

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

Select a supported Endpoint version, including an older one, or omit for the default. Unavailable or retired versions return 409.

Required range: x > 0
task_id
string | null

The task this inspection belongs to, from a catalog search response. Any stable string is accepted.

metadata

Optional tracking fields, returned on the Run and available as filters. They never go to the Provider or affect routing, Price, or idempotency.

  • Up to 20 keys: lowercase letters, digits, and underscores; start with a letter; at most 40 characters.
  • Values: strings of 1–500 characters.
  • user_id: your End user's opaque ID, never their email address or name.

Invalid entries are dropped whole, not truncated. The request continues, and the Run returns the fields that were stored.

Response

Success

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

The Provider's brand name, for display: "People Data Labs" for provider "pdl". Identity stays with provider — that is the value run and inspect take, and this one is never sent back.

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

Supported Endpoint version. Compatible updates keep this version.

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

Current Price and charging rules. Price can change without an Endpoint version change. New Runs use the Price at admission; accepted Runs keep that Price.

run_mode
enum<string>
required
Available options:
sync,
async
method
enum<string>
required
Available options:
GET,
POST,
PUT,
PATCH,
DELETE,
HEAD
input_schema
object
required

Provider-native JSON Schema for Run input.

output_schema
object | null
required

JSON Schema for successful output. Null when no reliable schema is available; sample responses do not define a schema.

output_schema_source
enum<string> | null
required

Who defines the output schema: the Provider or Glasser. Null when output_schema is null.

Available options:
provider,
glasser
sample_input
object
required

Example input. Adjust it to your request and validate it against input_schema.

doc_url
string | null
required

Link to the Provider's documentation, when available.

timeout_ms
integer | null

For sync Endpoints, the maximum time in milliseconds from a Run request to its terminal response. Set your HTTP client timeout above this value.

Required range: x > 0
client
object