Conversation

Manage Agent Conversations (Preview)

Listing conversations

get

This functionality is in preview mode - some of the features may not be fully operational yet.

Retrieves agent conversations based on the provided query.

Required scopes

This endpoint requires the following scopes:

• : Needed to read AI agents.

Authorizations

OAuth2

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 conversations.

application/json

Represents an active agent conversation context (MS Teams channel or group chat).

conversationIdstringOptional

Provider-side conversation identifier (Teams conversation ID).

conversationNamestringOptional

Human-readable name of the conversation channel or group chat.

contextRefstringOptional

Caller-supplied reference key used to reuse an existing conversation.

channelIdstringOptional

Teams channel or chat identifier.

agentIdstringOptional

Identifier of the agent that owns this conversation.

sessionIdstringOptional

LangGraph session (checkpointer) ID for agent continuity.

lastMessageAtstring · date-timeOptional

Timestamp of the last message activity in this conversation.

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/conversations

HTTPcURLJavaScriptPython

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

[
  {
    "conversationId": "19:[e-mail]2",
    "conversationName": "Support - Order #12345",
    "contextRef": "order-12345",
    "channelId": "19:[e-mail]2",
    "agentId": "support-agent-id",
    "sessionId": "session-abc",
    "lastMessageAt": "2026-07-10T08:00:00Z"
  }
]

Searching conversations

post

This functionality is in preview mode - some of the features may not be fully operational yet.

Searches for agent conversations based on the provided query.

Required scopes

This endpoint requires the following scopes:

• : Needed to read AI agents.

Authorizations

OAuth2

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

application/json

qstringOptional

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

See: Standard Practices - Query parameter

Responses

200

List of conversations.

application/json

Represents an active agent conversation context (MS Teams channel or group chat).

conversationIdstringOptional

Provider-side conversation identifier (Teams conversation ID).

conversationNamestringOptional

Human-readable name of the conversation channel or group chat.

contextRefstringOptional

Caller-supplied reference key used to reuse an existing conversation.

channelIdstringOptional

Teams channel or chat identifier.

agentIdstringOptional

Identifier of the agent that owns this conversation.

sessionIdstringOptional

LangGraph session (checkpointer) ID for agent continuity.

lastMessageAtstring · date-timeOptional

Timestamp of the last message activity in this conversation.

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/conversations/search

HTTPcURLJavaScriptPython

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

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

[
  {
    "conversationId": "19:[e-mail]2",
    "conversationName": "Support - Order #12345",
    "contextRef": "order-12345",
    "channelId": "19:[e-mail]2",
    "agentId": "support-agent-id",
    "sessionId": "session-abc",
    "lastMessageAt": "2026-07-10T08:00:00Z"
  }
]