Skip to main content
GET
Read an agent search

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Headers

x-api-version
enum<string>
default:2025-11-01
required

API version to use. This endpoint currently requires 2025-11-01.

Available options:
2025-11-01
Example:

"2025-11-01"

Path Parameters

search_id
string
required

The search_id that the start returned.

Example:

"1318-07fcae93f67c961a96c8758766b2fea1"

Response

The search.

A search, with its answer when it succeeded. Ignore a key you do not know, because new keys can come.

search_id
string
required

The id that the start returned.

Example:

"1318-07fcae93f67c961a96c8758766b2fea1"

query
string
required

The question as you sent it.

Example:

"The founders of Crustdata"

state
enum<string>
required

The state of a search. succeeded, failed and cancelled are end states. Every search in progress is running today. queued is not returned today; a later release adds it for a search that waits in a queue. Treat every state that is not an end state as in progress. This enum is closed.

Available options:
queued,
running,
succeeded,
failed,
cancelled
Example:

"running"

created_at
string<date-time>
required

When the search started.

Example:

"2026-11-13T11:32:26.860998+00:00"

output
object | null
required

The answer. It is set only when state is succeeded.

Example:
credits_used
object
required

The charge, in credits. It grows with the effort of the search. Every key is 0 until the search is charged. A search that finds nothing, fails, or is cancelled costs 0. total_cost is the sum of the 4 parts.

error
object | null
required

Why the search failed. It is set only when state is failed.

Example: