Gets a paginated list of agent instances for a given agent

GET 
/api/v2/AgentInstance/:agentCode

Gets a paginated list of agent instances for a given agent

Request

Path Parameters

agentCode stringrequired

The unique code identifying the agent.

Query Parameters

userIdentifier string

Optional user identifier to filter by.

groupIdentifier string

Optional group identifier to filter by.

term string

Optional search term to filter by name.

sortDirection string

Default value: desc

Sort direction by start date: "asc" or "desc". Default is "desc".

page int32

Default value: 1

The page number to retrieve. Default is 1.

pageSize int32

Default value: 20

The number of items per page. Default is 20.

culture string

Use this param to override the culture of the response. Options: - en (default) - es

Responses

200

OK

text/plain

Schema

Schema

items

object[]

nullable

Array [

links

object[]

nullable

Array [

method stringnullable

url stringnullable

rel stringnullable

]

id stringnullable

name stringnullable

agentVersion int32nullable

startDate date-time

endDate date-time

timeToFirstToken int64nullable

channel stringnullable

userIdentifier stringnullable

groupIdentifier stringnullable

ipAddress stringnullable

userAgent stringnullable

usage

object

promptTokens int32

completionTokens int32

totalTokens int32

costs

object

prompt double

completion double

services double

total double

currency stringnullable

]

total int64
pageSize int32
page int32

links

object[]

nullable

Array [

method stringnullable

url stringnullable

rel stringnullable

]

Example (from schema)

{
  "items": [
    {
      "links": [
        {
          "method": "string",
          "url": "string",
          "rel": "string"
        }
      ],
      "id": "string",
      "name": "string",
      "agentVersion": 0,
      "startDate": "2024-07-29T15:51:28.071Z",
      "endDate": "2024-07-29T15:51:28.071Z",
      "timeToFirstToken": 0,
      "channel": "string",
      "userIdentifier": "string",
      "groupIdentifier": "string",
      "ipAddress": "string",
      "userAgent": "string",
      "usage": {
        "promptTokens": 0,
        "completionTokens": 0,
        "totalTokens": 0
      },
      "costs": {
        "prompt": 0,
        "completion": 0,
        "services": 0,
        "total": 0,
        "currency": "string"
      }
    }
  ],
  "total": 0,
  "pageSize": 0,
  "page": 0,
  "links": [
    {
      "method": "string",
      "url": "string",
      "rel": "string"
    }
  ]
}

application/json

Schema

Schema

items

object[]

nullable

Array [

links

object[]

nullable

Array [

method stringnullable

url stringnullable

rel stringnullable

]

id stringnullable

name stringnullable

agentVersion int32nullable

startDate date-time

endDate date-time

timeToFirstToken int64nullable

channel stringnullable

userIdentifier stringnullable

groupIdentifier stringnullable

ipAddress stringnullable

userAgent stringnullable

usage

object

promptTokens int32

completionTokens int32

totalTokens int32

costs

object

prompt double

completion double

services double

total double

currency stringnullable

]

total int64
pageSize int32
page int32

links

object[]

nullable

Array [

method stringnullable

url stringnullable

rel stringnullable

]

Example (from schema)

{
  "items": [
    {
      "links": [
        {
          "method": "string",
          "url": "string",
          "rel": "string"
        }
      ],
      "id": "string",
      "name": "string",
      "agentVersion": 0,
      "startDate": "2024-07-29T15:51:28.071Z",
      "endDate": "2024-07-29T15:51:28.071Z",
      "timeToFirstToken": 0,
      "channel": "string",
      "userIdentifier": "string",
      "groupIdentifier": "string",
      "ipAddress": "string",
      "userAgent": "string",
      "usage": {
        "promptTokens": 0,
        "completionTokens": 0,
        "totalTokens": 0
      },
      "costs": {
        "prompt": 0,
        "completion": 0,
        "services": 0,
        "total": 0,
        "currency": "string"
      }
    }
  ],
  "total": 0,
  "pageSize": 0,
  "page": 0,
  "links": [
    {
      "method": "string",
      "url": "string",
      "rel": "string"
    }
  ]
}

text/json

Schema

Schema

items

object[]

nullable

Array [

links

object[]

nullable

Array [

method stringnullable

url stringnullable

rel stringnullable

]

id stringnullable

name stringnullable

agentVersion int32nullable

startDate date-time

endDate date-time

timeToFirstToken int64nullable

channel stringnullable

userIdentifier stringnullable

groupIdentifier stringnullable

ipAddress stringnullable

userAgent stringnullable

usage

object

promptTokens int32

completionTokens int32

totalTokens int32

costs

object

prompt double

completion double

services double

total double

currency stringnullable

]

total int64
pageSize int32
page int32

links

object[]

nullable

Array [

method stringnullable

url stringnullable

rel stringnullable

]

Example (from schema)

{
  "items": [
    {
      "links": [
        {
          "method": "string",
          "url": "string",
          "rel": "string"
        }
      ],
      "id": "string",
      "name": "string",
      "agentVersion": 0,
      "startDate": "2024-07-29T15:51:28.071Z",
      "endDate": "2024-07-29T15:51:28.071Z",
      "timeToFirstToken": 0,
      "channel": "string",
      "userIdentifier": "string",
      "groupIdentifier": "string",
      "ipAddress": "string",
      "userAgent": "string",
      "usage": {
        "promptTokens": 0,
        "completionTokens": 0,
        "totalTokens": 0
      },
      "costs": {
        "prompt": 0,
        "completion": 0,
        "services": 0,
        "total": 0,
        "currency": "string"
      }
    }
  ],
  "total": 0,
  "pageSize": 0,
  "page": 0,
  "links": [
    {
      "method": "string",
      "url": "string",
      "rel": "string"
    }
  ]
}

401

The user is unauthorized or the session expired

403

The user does not have permission

404

The entity was not found

500

There was an unexpected error

Loading...