Retrieve agents by external ID

Retrieve agents by their external IDs. The response returns the agents in the same order as in the request.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
ignoreUnknownIds
boolean (Ignoreunknownids)
Default: false

If true, ignores unknown external IDs.

required
Array of objects (Items) [ 1 .. 100 ] items

A list of agent external IDs.

Responses
200

Successful Response

400

The response for a failed request.

post/ai/agents/byids
Request samples
application/json
{
  • "ignoreUnknownIds": false,
  • "items": [
    • {
      }
    ]
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ]
}
➔ Next to Start a chat session with an agent