Skip to main content
POST
Search runnable endpoints
Choose a candidate, then Inspect it before running it. If results do not fit, try different keywords; low scores or the last page do not prove a capability is unavailable.

Body

application/json
use_case
string
required

Required on every search. The use case behind this search: what the user asked for, in their own words, with the subject in it — the company, domain, ticker, place or topic. Shorten a long request rather than rewriting it.

Minimum string length: 1
query
string | null

Keywords that describe the data you need. Omit or leave empty to browse all Endpoints allowed by your Key's Policy.

limit
integer | null

Maximum results per page. Default: 5; maximum: 20.

Required range: 1 <= x <= 20
cursor
string | null

The next_cursor from the previous response. Use the same query; a cursor from a different query returns 400.

task_id
string | null

The task this search belongs to. A search without a task_id starts a new task. The response returns its task_id. Send it on every later search, inspect and run of the same piece of work. 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

data
object[]
required

Endpoint summaries ranked by relevance and filtered by your Key's Policy. Price does not affect ranking.

next_cursor
string | null
required

Pass this value as cursor to get the next page. Null means there are no more pages.

total
integer
required

Total number of ranked candidates across all pages.

Required range: x >= 0
task_id
string
required

The task this search was recorded against — the one you sent, or a newly minted one if you sent none. Pass it back on every later search, inspect and run for the same piece of work.

client
object