> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agntix.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Close Session

> Close an open session. No further messages can be sent after closing.

<Note>
  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](/authentication) for the full setup.
</Note>

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

## Code examples

<CodeGroup>
  ```bash curl theme={null}
  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" }'
  ```

  ```javascript Node.js theme={null}
  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"
  ```

  ```python Python theme={null}
  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"
  ```
</CodeGroup>

## Sample response

```json theme={null}
{
  "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"
}
```


## OpenAPI

````yaml PATCH /v1/chat/chat/sessions/{sessionId}/close
openapi: 3.0.3
info:
  title: Agntix API
  version: 1.0.0
  description: >-
    The Agntix API lets you build, deploy, and operate AI chat and voice agents.
    All requests are sent to `https://api.agntix.ai`. Authenticate with an API
    key (`x-api-key`) or a Clerk-issued JWT (`Authorization: Bearer <token>`).


    Base URL: `https://api.agntix.ai`
servers:
  - url: https://api.agntix.ai
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Agents
    description: >-
      Create and manage AI agents — the core building block of Agntix. An agent
      encapsulates a system prompt, LLM, tools, knowledge store, and voice
      configuration.
  - name: Chat
    description: >-
      Open chat sessions with an agent and exchange messages. Supports streaming
      responses over SSE.
  - name: Voice
    description: >-
      List available voices and TTS/STT models, and create real-time voice
      sessions.
  - name: Tools
    description: >-
      Extend agent capabilities with API tools (webhook calls) or function tools
      (server-side logic).
  - name: Phone Numbers
    description: >-
      Provision and manage telephony numbers for inbound and outbound voice
      calls.
  - name: Models
    description: Browse available LLM, STT, and TTS models supported by Agntix.
  - name: Analytics
    description: Query call and agent-level performance metrics.
  - name: API Keys
    description: Create and manage organization-scoped API keys.
  - name: Contacts
    description: Manage customer contacts that can be linked to chat sessions.
  - name: Call Campaigns
    description: Launch and manage outbound call campaigns against a list of contacts.
  - name: Subscriptions
    description: View billing plans, usage quotas, and manage Stripe subscriptions.
paths:
  /v1/chat/chat/sessions/{sessionId}/close:
    patch:
      tags:
        - Chat
      summary: Close session
      description: >-
        Closes an open session. Once closed, no further messages can be sent.
        Triggers session-closed webhooks if configured.
      operationId: closeSession
      parameters:
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                reason:
                  type: string
                  description: Optional reason for closing the session.
                  example: RESOLVED
      responses:
        '200':
          description: Session closed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatSession'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    ChatSession:
      type: object
      properties:
        id:
          type: string
          example: ses_01j3m8xkqp8v2nw4f7g9hk0r
        agentId:
          type: string
          format: uuid
        platform:
          type: string
          example: SDK
        state:
          type: string
          enum:
            - OPEN
            - CLOSED
          example: OPEN
        metadata:
          type: object
          additionalProperties: true
        orgId:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
              example: Resource not found.
            status:
              type: integer
              example: 404
        meta:
          type: object
          properties:
            requestId:
              type: string
            timestamp:
              type: string
              format: date-time
  responses:
    Unauthorized:
      description: Missing or invalid authentication credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required.
              status: 401
            meta:
              requestId: req_01j3m...
              timestamp: '2026-04-29T10:00:00Z'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Agent not found.
              status: 404
            meta:
              requestId: req_01j3m...
              timestamp: '2026-04-29T10:00:00Z'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Organization API key. Obtain from the
        [dashboard](https://app.agntix.ai/settings/api-keys). Format:
        `pk_live_…`
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Clerk-issued JWT. Use `Authorization: Bearer <token>`.'

````