Skip to main content

Gets a paginated list of agent instances for a given agent version

GET 
/api/v2/AgentInstance/:agentCode/:agentVersion

Gets a paginated list of agent instances for a given agent version

Request​

Path Parameters

    agentCode stringrequired

    The unique code identifying the agent.

    agentVersion int32required

    Optional agent version to filter by.

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​

OK

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

  • ]

Loading...