Skip to main content
POST
/
v1
/
chat
Create Chat
curl --request POST \
  --url https://api.sigmamind.ai/v1/chat \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "agentId": "D5D0p7TUs66TTAEAx",
  "conversation": "Hey, How are you?",
  "variables": {
    "customer_name": "Michael"
  }
}
'
{
  "id": "<string>",
  "createdAt": "2021-04-20T10:00:00.000Z",
  "updatedAt": "2021-04-20T10:00:00.000Z",
  "status": "<string>",
  "error": "<string>",
  "response": [
    {
      "id": "<string>",
      "role": "<string>",
      "type": "<string>",
      "content": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

API Key is required in header. You can find it in the settings

Body

application/json
​
agentId
string
required

The unique identifier of the Agent assigned to handle the chat completion.

Example:

"D5D0p7TUs66TTAEAx"

​
conversation
string

Input message of the customer or history of the conversation

Example:

"Hey, How are you?"

​
variables
object

A set of dynamic key-value pairs required by the selected Agent. These variables allow personalization of the call, such as passing the customer’s name or other contextual details.

Example:
{ "customer_name": "Michael" }

Response

OK

​
id
string
​
createdAt
string<date-time>

The timestamp when the call record was created.

Example:

"2021-04-20T10:00:00.000Z"

​
updatedAt
string<date-time>

The timestamp when the call record was last updated.

Example:

"2021-04-20T10:00:00.000Z"

​
status
string
​
error
string
​
response
object[]