Skip to main content

Get agent instance detail

GET 
/api/v2/agent/:agentCode/instance/:agentInstanceId

Gets the detail of a single system-agent instance (Chat / Activity / AIProxyRequest). The base response always includes the instance request and response; use include to expand optional execution sections (input, skills, knowledge), each loaded only when requested.

Request​

Path Parameters

    agentCode stringrequired

    The unique code identifying the agent the instance belongs to.

    agentInstanceId uuidrequired

    The instance id.

Query Parameters

    include string

    Comma-separated list of optional sections to include: input (the full set of inputs the instance received), skills, knowledge. Each section is loaded only when requested.

    culture string

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

Responses​

OK

Schema

    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
    origin stringnullable
    referer stringnullable

    usage

    object

    promptTokens int32
    completionTokens int32
    totalTokens int32

    costs

    object

    prompt double
    completion double
    services double
    total double
    currency stringnullable

    citations

    object[]

    nullable

  • Array [

    • citationIndex int32
    startIndex int32
    endIndex int32
    relevance double

    source

    object

    nullable

    oneOf

    fileName stringnullable
    knowledgeFileVersionId uuid
    sectionId stringnullable
    pageRange stringnullable

  • ]

    • type stringnullable
    request stringnullable
    response stringnullable

    input

    object[]

    nullable

    The full set of inputs the instance received during its execution, as key/value parameters.

    Populated only when include=input is requested.

  • Array [

    • key stringnullable
    value nullable

  • ]

    • skills

    object[]

    nullable

    The skills (plugins) executed during the instance.

    Populated only when include=skills is requested.

  • Array [

    • name stringnullable
    tool stringnullable

    input

    object[]

    nullable

  • Array [

    • key stringnullable
    value nullable

  • ]

    • output stringnullable

    usage

    object

    promptTokens int32
    completionTokens int32
    totalTokens int32
    success boolean
    error stringnullable
    iteration int32nullable
    durationMs int64nullable
    startDate date-time

  • ]

    • knowledge

    object[]

    nullable

    The knowledge retrieved during the instance.

    Populated only when include=knowledge is requested.

  • Array [

    • fileId stringnullable
    fileName stringnullable
    content stringnullable
    relevance double
    pageFrom int32
    pageTo int32
    position int32
    totalTokenCount int32

  • ]

Loading...