Agent Logs

Read Agent Logs

Listing agent requests

get

Retrieves agent requests based on the provided query.

Required scopes

ai.agent_read

Required scopes

This endpoint requires the following scopes:

: Needed to read AI agents.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Query parameters

qstringOptional

A standard query parameter is used to search for specific values.

See: Standard Practices - Query parameter

pageSizestringOptional

The number of documents to be retrieved per page.

pageNumberstringOptional

The page number to be retrieved. The size of the pages should be specified by the pageSize parameter.

sortstringOptional

List of properties used to sort the results, separated by colons.

fieldsstringOptional

Fields to be returned in the response.

Header parameters

X-Total-CountbooleanOptional

Flag indicating whether the total number of retrieved results should be returned.

Responses

200

List of agent requests.

application/json

400

The request was syntactically incorrect.

application/json

401

The authorization token is invalid or has expired.

application/json

403

Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.

application/json

get

/ai-service/{tenant}/agentic/logs/requests

GET /ai-service/{tenant}/agentic/logs/requests HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "req-123e4567-e89b-12d3-a456-426614174000",
    "sessionId": "sess-123e4567-e89b-12d3-a456-426614174000",
    "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
    "triggerAgentId": "complaint-agent",
    "collaborationAgents": [
      "support-agent"
    ],
    "severity": "INFO",
    "messages": [
      {
        "timestamp": "2025-01-15T10:30:27.167Z",
        "severity": "INFO",
        "message": "Agent started processing request",
        "agentId": "complaint-agent",
        "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
        "isBusinessLog": false
      },
      {
        "timestamp": "2025-01-15T10:30:28.234Z",
        "severity": "INFO",
        "message": "Retrieved order details successfully",
        "agentId": "complaint-agent",
        "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
        "isBusinessLog": true
      }
    ],
    "duration": 45,
    "metadata": {
      "version": 1,
      "createdAt": "2025-01-15T10:30:27.167Z",
      "modifiedAt": "2025-01-15T10:30:28.234Z"
    }
  }
]

Retrieving agent request by ID

get

Retrieves the agent request by given ID.

Required scopes

ai.agent_read

Required scopes

This endpoint requires the following scopes:

: Needed to read AI agents.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

requestIdstringRequired

Query parameters

fieldsstringOptional

Fields to be returned in the response.

Responses

200

A single agent request.

application/json

401

The authorization token is invalid or has expired.

application/json

403

Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.

application/json

404

Example response

application/json

get

/ai-service/{tenant}/agentic/logs/requests/{requestId}

GET /ai-service/{tenant}/agentic/logs/requests/{requestId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "req-123e4567-e89b-12d3-a456-426614174000",
  "sessionId": "sess-123e4567-e89b-12d3-a456-426614174000",
  "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
  "triggerAgentId": "complaint-agent",
  "collaborationAgents": [
    "support-agent"
  ],
  "severity": "INFO",
  "messages": [
    {
      "timestamp": "2025-01-15T10:30:28.234Z",
      "severity": "INFO",
      "message": "Retrieved order details successfully",
      "agentId": "complaint-agent",
      "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
      "isBusinessLog": true
    },
    {
      "timestamp": "2025-01-15T10:30:29.456Z",
      "severity": "WARNING",
      "message": "Order status check returned unexpected value",
      "agentId": "complaint-agent",
      "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
      "isBusinessLog": false
    }
  ],
  "duration": 45,
  "metadata": {
    "version": 1,
    "createdAt": "2025-01-15T10:30:27.167Z",
    "modifiedAt": "2025-01-15T10:30:29.456Z"
  }
}

Searching agent requests

post

Searches for agent requests based on the provided query.

Required scopes

ai.agent_read

Required scopes

This endpoint requires the following scopes:

: Needed to read AI agents.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Query parameters

pageSizestringOptional

The number of documents to be retrieved per page.

pageNumberstringOptional

The page number to be retrieved. The size of the pages should be specified by the pageSize parameter.

sortstringOptional

List of properties used to sort the results, separated by colons.

fieldsstringOptional

Fields to be returned in the response.

Header parameters

X-Total-CountbooleanOptional

Flag indicating whether the total number of retrieved results should be returned.

Body

qstringOptional

A standard query parameter is used to search for specific values.

See: Standard Practices - Query parameter

Responses

200

List of agent requests.

application/json

400

The request was syntactically incorrect.

application/json

401

The authorization token is invalid or has expired.

application/json

403

Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.

application/json

post

/ai-service/{tenant}/agentic/logs/requests/search

POST /ai-service/{tenant}/agentic/logs/requests/search HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "q": "name:~Support"
}

[
  {
    "id": "req-123e4567-e89b-12d3-a456-426614174000",
    "sessionId": "sess-123e4567-e89b-12d3-a456-426614174000",
    "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
    "triggerAgentId": "complaint-agent",
    "collaborationAgents": [
      "support-agent"
    ],
    "severity": "INFO",
    "messages": [
      {
        "timestamp": "2025-01-15T10:30:27.167Z",
        "severity": "INFO",
        "message": "Agent started processing request",
        "agentId": "complaint-agent",
        "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
        "isBusinessLog": false
      },
      {
        "timestamp": "2025-01-15T10:30:28.234Z",
        "severity": "INFO",
        "message": "Retrieved order details successfully",
        "agentId": "complaint-agent",
        "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
        "isBusinessLog": true
      }
    ],
    "duration": 45,
    "metadata": {
      "version": 1,
      "createdAt": "2025-01-15T10:30:27.167Z",
      "modifiedAt": "2025-01-15T10:30:28.234Z"
    }
  }
]

Listing agent sessions

get

Retrieves agent sessions based on the provided query.

Required scopes

ai.agent_read

Required scopes

This endpoint requires the following scopes:

: Needed to read AI agents.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Query parameters

qstringOptional

A standard query parameter is used to search for specific values.

See: Standard Practices - Query parameter

pageSizestringOptional

The number of documents to be retrieved per page.

pageNumberstringOptional

The page number to be retrieved. The size of the pages should be specified by the pageSize parameter.

sortstringOptional

List of properties used to sort the results, separated by colons.

fieldsstringOptional

Fields to be returned in the response.

Header parameters

X-Total-CountbooleanOptional

Flag indicating whether the total number of retrieved results should be returned.

Responses

200

List of agent sessions.

application/json

400

The request was syntactically incorrect.

application/json

401

The authorization token is invalid or has expired.

application/json

403

Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.

application/json

get

/ai-service/{tenant}/agentic/logs/sessions

GET /ai-service/{tenant}/agentic/logs/sessions HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "sessionId": "sess-123e4567-e89b-12d3-a456-426614174000",
    "triggerAgentId": "complaint-agent",
    "severity": "INFO",
    "agents": [
      "complaint-agent",
      "support-agent"
    ],
    "messages": [
      {
        "timestamp": "2025-01-15T10:30:27.167Z",
        "severity": "INFO",
        "message": "Session started",
        "agentId": "complaint-agent",
        "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
        "isBusinessLog": false
      },
      {
        "timestamp": "2025-01-15T10:30:28.234Z",
        "severity": "INFO",
        "message": "Handed off to support agent",
        "agentId": "complaint-agent",
        "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
        "isBusinessLog": true
      }
    ],
    "duration": 120,
    "metadata": {
      "version": 1,
      "createdAt": "2025-01-15T10:30:27.167Z",
      "modifiedAt": "2025-01-15T10:30:29.234Z"
    }
  }
]

Retrieving agent session by ID

get

Retrieves the agent session by given ID.

Required scopes

ai.agent_read

Required scopes

This endpoint requires the following scopes:

: Needed to read AI agents.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

sessionIdstringRequired

Query parameters

fieldsstringOptional

Fields to be returned in the response.

Responses

200

A single agent session.

application/json

401

The authorization token is invalid or has expired.

application/json

403

Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.

application/json

404

Example response

application/json

get

/ai-service/{tenant}/agentic/logs/sessions/{sessionId}

GET /ai-service/{tenant}/agentic/logs/sessions/{sessionId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "sessionId": "sess-123e4567-e89b-12d3-a456-426614174000",
  "triggerAgentId": "complaint-agent",
  "severity": "INFO",
  "agents": [
    "complaint-agent",
    "support-agent"
  ],
  "messages": [
    {
      "timestamp": "2025-01-15T10:30:28.234Z",
      "severity": "INFO",
      "message": "Retrieved order details successfully",
      "agentId": "complaint-agent",
      "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
      "isBusinessLog": true
    },
    {
      "timestamp": "2025-01-15T10:30:30.789Z",
      "severity": "INFO",
      "message": "Support agent processing request",
      "agentId": "support-agent",
      "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
      "isBusinessLog": false
    }
  ],
  "duration": 120,
  "metadata": {
    "version": 1,
    "createdAt": "2025-01-15T10:30:27.167Z",
    "modifiedAt": "2025-01-15T10:30:30.789Z"
  }
}

Searching agent sessions

post

Searches for agent sessions based on the provided query.

Required scopes

ai.agent_read

Required scopes

This endpoint requires the following scopes:

: Needed to read AI agents.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Query parameters

pageSizestringOptional

The number of documents to be retrieved per page.

pageNumberstringOptional

The page number to be retrieved. The size of the pages should be specified by the pageSize parameter.

sortstringOptional

List of properties used to sort the results, separated by colons.

fieldsstringOptional

Fields to be returned in the response.

Header parameters

X-Total-CountbooleanOptional

Flag indicating whether the total number of retrieved results should be returned.

Body

qstringOptional

A standard query parameter is used to search for specific values.

See: Standard Practices - Query parameter

Responses

200

List of agent sessions.

application/json

400

The request was syntactically incorrect.

application/json

401

The authorization token is invalid or has expired.

application/json

403

Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.

application/json

post

/ai-service/{tenant}/agentic/logs/sessions/search

POST /ai-service/{tenant}/agentic/logs/sessions/search HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "q": "name:~Support"
}

[
  {
    "sessionId": "sess-123e4567-e89b-12d3-a456-426614174000",
    "triggerAgentId": "complaint-agent",
    "severity": "INFO",
    "agents": [
      "complaint-agent",
      "support-agent"
    ],
    "messages": [
      {
        "timestamp": "2025-01-15T10:30:27.167Z",
        "severity": "INFO",
        "message": "Session started",
        "agentId": "complaint-agent",
        "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
        "isBusinessLog": false
      },
      {
        "timestamp": "2025-01-15T10:30:28.234Z",
        "severity": "INFO",
        "message": "Handed off to support agent",
        "agentId": "complaint-agent",
        "requestId": "req-123e4567-e89b-12d3-a456-426614174000",
        "isBusinessLog": true
      }
    ],
    "duration": 120,
    "metadata": {
      "version": 1,
      "createdAt": "2025-01-15T10:30:27.167Z",
      "modifiedAt": "2025-01-15T10:30:29.234Z"
    }
  }
]

PreviousAgent Chat NextAgent Template

Last updated 11 hours ago

Was this helpful?

Good evening

Listing agent requests

Required scopes

Retrieving agent request by ID

Required scopes

Searching agent requests

Required scopes

Listing agent sessions

Required scopes

Retrieving agent session by ID

Required scopes

Searching agent sessions

Required scopes