v1

latestOpenAPI 3.1.02026-07-2658119246.0 KB

Public API

List Agents

List the active Web Search Agents in your account. Results are scoped to the workspace resolved from your token (or the optional workspace_id query parameter) and paginated with offset/limit.

get/v2/agents

Query parameters

workspace_idstring uuid nullable

Only return agents belonging to this workspace. Defaults to the workspace resolved from your token.

offsetinteger

Number of items to skip before this page.

limitinteger

Maximum number of items to return (1-200).

Response

Successful Response

limitinteger required

Maximum number of items returned.

offsetinteger required

Number of items skipped before this page.

totalinteger required

Total number of items matching the query.

Example response

{
  "items": [
    {
      "display_name": "Company News Tracker",
      "id": "wsa_2af5b0e2-58b8-4b60-a1a4-9e57e4d33f00",
      "sources": {
        "allow": [
          {
            "domains": [
              "linkedin.com",
              "crunchbase.com"
            ],
            "title": "Professional networks"
          }
        ],
        "block": [
          {
            "domains": [
              "linkedin.com",
              "crunchbase.com"
            ],
            "title": "Professional networks"
          }
        ]
      }
    }
  ]
}