Agent Chat

Chat With Agents

Starting agent chat

post

Allows for communication with Emporix agents.

Required scopes

This endpoint requires the following scopes:

• : Needed to execute agentic chat.
• : Needed to execute agentic chat by customers.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

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

Header parameters

session-idstring · uuidOptional

Unique session identifier which allows for storing the context of the chat. If not provided, the system generates it.

Body

application/json

agentIdstringRequired

Unique identifier of the agent.

messagestringRequired

The user message to the agent.

Responses

200

Chat response.

application/json

agentIdstringOptional

Unique identifier of the agent.

agentTypestring · enumOptional

Type of the agent handling the request.

Possible values:

sessionIdstringOptional

Unique identifier of the session.

messagestringOptional

Agent message.

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

500

A server-side error occurred.

application/json

post

/ai-service/{tenant}/agentic/chat

HTTPcURLJavaScriptPython

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

{
  "agentId": "complaint-agent",
  "message": "Find a product with \"EON1243\" code"
}

[
  {
    "agentId": "complaint-agent",
    "agentType": "complaint",
    "message": "Found an order with its details.",
    "sessionId": "fe91d168-4ce9-4b4d-8451-0029035b34a5"
  }
]

Starting agent async chat

post

Allows for communication with Emporix agents in async way.

Required scopes

This endpoint requires the following scopes:

• : Needed to execute agentic chat.
• : Needed to execute agentic chat by customers.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

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

Header parameters

session-idstring · uuidOptional

Unique session identifier which allows for storing the context of the chat. If not provided, the system generates it.

Body

application/json

agentIdstringRequired

Unique identifier of the agent.

messagestringRequired

The user message to the agent.

Responses

201

Job ID response.

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

500

A server-side error occurred.

application/json

post

/ai-service/{tenant}/agentic/chat-async

HTTPcURLJavaScriptPython

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

{
  "agentId": "complaint-agent",
  "message": "Find a product with \"EON1243\" code"
}

{
  "jobId": "68835cc3ef4e8e1425c360ad"
}

Uploading attachment

post

Allows for upload of a file and assign it to the agent. Supported file extensions:

• jpg

• jpeg

• png

• pdf

• csv

• text

• txt

Path parameters

tenantstringRequired

Your Emporix tenant name.

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

agentIdstringRequired

Header parameters

session-idstring · uuidOptional

Unique session identifier which allows for storing the context of the chat. If not provided, the system generates it.

Body

multipart/form-data

attachmentstring · binaryRequired

Content of the file.

Responses

201

Attachment response.

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

500

A server-side error occurred.

application/json

post

/ai-service/{tenant}/agentic/{agentId}/attachments

HTTPcURLJavaScriptPython

POST /ai-service/{tenant}/agentic/{agentId}/attachments HTTP/1.1
Host: api.emporix.io
Content-Type: multipart/form-data
Accept: */*
Content-Length: 23

{
  "attachment": "binary"
}

{
  "id": "68835cc3ef4e8e1425c360ad",
  "sessionId": "0499bef6-a4d2-45b9-86a0-2edf7d70d726"
}