Skip to main content
GET
List agents

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Scopes

https://{cluster}.cognitedata.com/.default
oidc-token
https://{cluster}.cognitedata.com/.default
oauth2-client-credentials
https://api.cognitedata.com/.default
oauth2-open-industrial-data
https://{cluster}.cognitedata.com/.default
oauth2-auth-code

Query Parameters

skillName
string

Filter agents by skill name.

Required string length: 1 - 64
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
skillExternalId
string

Filter agents by skill external ID.

Required string length: 1 - 128
Pattern: ^[^\x00]{1,128}$

Response

Successful Response

items
AgentListResponseItem · object[]
required

A list of agents.