Close Session

PATCH

chat

sessions

{sessionId}

Close session

curl --request PATCH \
  --url https://api.agntix.ai/v1/chat/chat/sessions/{sessionId}/close \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "reason": "RESOLVED"
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'RESOLVED'})
};

fetch('https://api.agntix.ai/v1/chat/chat/sessions/{sessionId}/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.agntix.ai/v1/chat/chat/sessions/{sessionId}/close"

payload = { "reason": "RESOLVED" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "ses_01j3m8xkqp8v2nw4f7g9hk0r",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "platform": "SDK",
  "state": "OPEN",
  "metadata": {},
  "orgId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required.",
    "status": 401
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Agent not found.",
    "status": 404
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

Every endpoint on this page requires either a Clerk-issued JWT (Authorization: Bearer <token>) or an organization API key (x-api-key: pk_…). Anonymous calls return 401 Unauthorized. See Authentication for the full setup.

Closing a session triggers session.closed webhooks if you have them configured. Closed sessions remain readable — you can still fetch messages and session details.

Code examples

curl -X PATCH https://api.agntix.ai/v1/chat/chat/sessions/ses_01j3m8xkqp8v2nw4f7g9hk0r/close \
  -H "x-api-key: pk_live_••••" \
  -H "Content-Type: application/json" \
  -d '{ "reason": "RESOLVED" }'

const sessionId = 'ses_01j3m8xkqp8v2nw4f7g9hk0r';

const session = await fetch(
  `https://api.agntix.ai/v1/chat/chat/sessions/${sessionId}/close`,
  {
    method: 'PATCH',
    headers: {
      'x-api-key': 'pk_live_••••',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ reason: 'RESOLVED' }),
  },
).then(r => r.json());

console.log('Session state:', session.state); // "CLOSED"

import httpx

session_id = "ses_01j3m8xkqp8v2nw4f7g9hk0r"

session = httpx.patch(
    f"https://api.agntix.ai/v1/chat/chat/sessions/{session_id}/close",
    headers={"x-api-key": "pk_live_••••"},
    json={"reason": "RESOLVED"},
).json()

assert session["state"] == "CLOSED"

Sample response

{
  "id": "ses_01j3m8xkqp8v2nw4f7g9hk0r",
  "agentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "platform": "SDK",
  "state": "CLOSED",
  "metadata": { "userId": "usr_123" },
  "createdAt": "2026-04-29T09:00:00Z",
  "updatedAt": "2026-04-29T09:45:00Z"
}

Authorizations

x-api-key

string

header

required

Organization API key. Obtain from the dashboard. Format: pk_live_…

Path Parameters

sessionId

string

required

Body

application/json

reason

string

Optional reason for closing the session.

Example:

"RESOLVED"

Response

Session closed.

string

Example:

"ses_01j3m8xkqp8v2nw4f7g9hk0r"

agentId

string<uuid>

platform

string

Example:

"SDK"

state

enum<string>

Available options:

OPEN,

CLOSED

Example:

"OPEN"

metadata

object

orgId

string

createdAt

string<date-time>

updatedAt

string<date-time>

Close session

curl --request PATCH \
  --url https://api.agntix.ai/v1/chat/chat/sessions/{sessionId}/close \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "reason": "RESOLVED"
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'RESOLVED'})
};

fetch('https://api.agntix.ai/v1/chat/chat/sessions/{sessionId}/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.agntix.ai/v1/chat/chat/sessions/{sessionId}/close"

payload = { "reason": "RESOLVED" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "ses_01j3m8xkqp8v2nw4f7g9hk0r",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "platform": "SDK",
  "state": "OPEN",
  "metadata": {},
  "orgId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required.",
    "status": 401
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Agent not found.",
    "status": 404
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

Overview

Agents

Chat

Voice

Tools

Phone Numbers

Code examples

Sample response

Authorizations

Path Parameters

Body

Response

​Code examples

​Sample response

Authorizations

Path Parameters

Body

Response

Code examples

Sample response