Search registered agents

Searches registered agents using request-body criteria and returns ranked results.

Full description

Searches registered agents using request-body criteria and returns ranked results. Anonymous requests are accepted when the Authorization header is omitted and are rate limited to 60 requests per minute per client IP.

Authorization

AuthorizationBearer <token>

GoDaddy OAuth 2.0 access token sent as Authorization: Bearer <token>. The scope(s) listed on each operation are enforced per-operation. A token requires at least one of the scopes listed for that operation; ans.agent-registration:write implies ans.agent-registration:read on every ANS operation. Scopes do not apply to API key authentication.

In: header

Scope: ans.agent-registration:read

Header Parameters

X-Request-Id?string

Optional request identifier propagated across services.

Formatuuid

Request Body

application/json

Search parameters

Search criteria for agent discovery.

query?string

Optional search query string. If omitted and no filters are provided, the API returns all agents except REVOKED by default. When statuses is explicitly provided, the API uses only the provided status values. Max length is 256 characters by default. When keywordExtraction=true, max length is 4096 characters.

keywordExtraction?boolean

When true, extracts keywords from the query text before searching. Increases max query length from 256 to 4096 characters. Requires query to be non-empty.

Defaultfalse

keywordAlgorithm?string

Keyword extraction algorithm to use when keywordExtraction=true.

Default"SIMPLE"

Value in

"RAKE"
"SIMPLE"
"TEXTRANK"

profile?string

Scoring profile name. Cannot be combined with scoring.pillarWeights in the same request.

Default"default"

scoring?

Optional scoring overrides for this request.

pageSize?integer

Number of results per page (1-100).

Range1 <= value <= 100

Default20

pageToken?string

Opaque token from a previous response links[].href relation (rel=next or rel=prev).

pageTokenDirection?string

Optional token direction when pageToken is set. Only valid when pageToken is provided. Requests that send pageTokenDirection without pageToken return 422 INVALID_REQUEST.

Value in

"backward"
"forward"

totalRequired?boolean

When true, include totalItems and totalPages in the response envelope.

Defaultfalse

providerIds?array<string>

Filter by provider IDs.

statuses?array<>

Filter by lifecycle statuses. When omitted, default behavior excludes REVOKED.

agentDomains?array<string>

Agent host domain-family filters. Each value matches apex plus subdomains.

tags?array<string>

Filter by endpoint function tags (endpoints.functions.tags).

protocols?array<>

Filter by endpoint protocols.

transports?array<>

Filter by endpoint transports.

capabilities?array<string>

Filter by function names (endpoints.functions.name).

Response Body

`/`

curl -X POST "https://example.com/v1/ans/search-registered-agents" \  -H "Content-Type: application/json" \  -d '{}'

{  "totalItems": 0,  "totalPages": 0,  "links": [    {      "href": "http://example.com",      "rel": "string",      "title": "string",      "targetMediaType": "string",      "targetSchema": {},      "method": "string",      "submissionMediaType": "application/json",      "submissionSchema": {}    }  ],  "items": [    {      "agentId": "string",      "indexedAt": "2019-08-24T14:15:22Z",      "leafIndex": 0,      "lifecycle": {        "status": "ACTIVE"      },      "agentDescription": "string",      "agentDisplayName": "string",      "agentHost": "string",      "agentVersion": "string",      "ansName": "string",      "logId": "string",      "providerId": "string",      "endpoints": [        {          "agentUrl": "string",          "documentationUrl": "string",          "metaDataUrl": "string",          "metaDataHash": "string",          "protocol": "A2A",          "transports": [            "HTTP"          ],          "functions": [            {              "id": "string",              "name": "string",              "tags": [                "string"              ]            }          ]        }      ],      "scores": {        "trustScore": 0,        "textScore": 0,        "relevance": 0.1      }    }  ]}

Last updated on

Search registered agents

Authorization

Header Parameters

Request Body

Response Body

200*/*

400*/*

401*/*

403*/*

415*/*

422*/*

429*/*

500*/*

502*/*

503*/*

504*/*

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`