Agent Chat

Chat With Agents

Starting agent chat

post

Allows for communication with Emporix's agents.

Required scopes

  • ai.completion_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant name.

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

Header parameters
session-idstring · uuidOptional

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

Body
agentIdstringRequired

Unique identifier of the agent.

messagestringRequired

The user message to the agent.

Responses
200

Chat response.

application/json
post
/ai-service/{tenant}/agentic/chat
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's agents in async way.

Required scopes

  • ai.completion_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant name.

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

Header parameters
session-idstring · uuidOptional

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

Body
agentIdstringRequired

Unique identifier of the agent.

messagestringRequired

The user message to the agent.

Responses
201

Job ID response.

application/json
post
/ai-service/{tenant}/agentic/chat-async
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"
  }
]

Last updated

Was this helpful?