Skip to main content
POST
Cancel 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 had already ended.

A search id and its state at the moment of the response.

search_id
string
required

The id of the search. Use it on every other route.

Example:

"1318-07fcae93f67c961a96c8758766b2fea1"

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"