SIsigmamind
Chats

Update Chat

Partially updates an in_progress chat session by chatId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated session record.

patch/v1/chats/{chatId}

Request

  • Base URL
    https://api.sigmamind.ai
  • Auth
    API key in header X-API-Key

Path parameters

chatIdstring required

Unique identifier of the chat session to update.

Request body

agentIdstring

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

dynamicVariablesobject

Dynamic key-value pairs required by the selected Agent for personalisation (e.g. customer name, account details).

Example request

{
  "agentId": "agent_D5D0p7TUs66TTAEAx",
  "dynamicVariables": {
    "customer_name": "Michael"
  }
}

Response

OK

chatIdstring

Unique identity for a chat

createdAtstring date-time

The timestamp when the call record was created.

statusstring

Status of chat

transcriptstring

transcript of the conversation in chat

dynamicVariablesJsonNode

Dynamic key-value pairs that were passed to the agent at call start for personalisation. Keys correspond to variable names defined in the agent's configuration (e.g., 'customer_name', 'account_id'). Null or empty if no dynamic variables were provided when the call was created.

Example response

{
  "chatId": "chat-d17T6uReChpyfFeP",
  "agent": {
    "name": "New AI Agent",
    "agentId": "agent_D5D0p7TUs66TTAEAx",
    "status": "Live"
  },
  "createdAt": "2021-04-20T10:00:00Z",
  "status": "ended",
  "response": [
    {
      "id": "item_G9YdhDqua0EngI1G",
      "role": "assistant",
      "type": "message",
      "content": [
        "Hello! My name is Grace, and I'm calling on behalf of SigmaMind AI. Am I speaking with Michael?"
      ]
    }
  ],
  "messages": [
    {
      "id": "item_G9YdhDqua0EngI1G",
      "role": "assistant",
      "type": "message",
      "content": [
        "Hello! My name is Grace, and I'm calling on behalf of SigmaMind AI. Am I speaking with Michael?"
      ]
    }
  ],
  "dynamicVariables": {
    "customer_name": "Michael",
    "account_id": "ACC-001"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.