v1

latestOpenAPI 3.1.02026-08-044257268.7 KB

Inspect

Get full endpoint details

Full endpoint details including input schema, pricing, and documentation. The provider's endpoint detail is the single source of truth.

post/v1/inspect

Request body

providerstring required

Provider slug.

endpointstring required

Endpoint path.

Example request

{
  "provider": "exa",
  "endpoint": "/search"
}

Response

Endpoint details

idstring required

Opaque inspection id (ULID).

providerstring required

Provider slug (e.g., "apify").

providerNamestring

Human-readable provider name (e.g., "Apify").

endpointstring required

Endpoint path.

descriptionstring required

summarystring

method'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'

HTTP method for this endpoint.

docUrlstring

Provider documentation URL.

notesstring[]

Operator-curated notes for agents — quirks, pitfalls, best practices.

tagsstring[] required

Tags for scoring and filtering (e.g., ["verified"]).

categoriesstring[] required

Depth-2 category paths — authored functional + derived provider (e.g. ["social-media/twitter"]). Empty when uncategorized.

hintsobject

Agent guidance map (phrase → hint), polymorphic by client: rendered command string for cli/api/mcp, structured target for web. Omitted for unknown clients.