# Create Text Chat Session

> POST /api/v1/workflow/{workflow_id}/text-chat/sessions — request parameters and responses from the Menace Voice API schema.

`POST /api/v1/workflow/{workflow_id}/text-chat/sessions`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| workflow_id | path | integer | yes |  |
| authorization | header | string or null | no |  |
| X-API-Key | header | string or null | no |  |

### Request body: application/json

Required body. Schema: CreateTextChatSessionRequest (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| name | string or null | no |  |
| initial_context | object or null | no |  |
| annotations | object or null | no |  |

### Response 200

Successful Response

application/json: WorkflowRunTextSessionResponse (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| workflow_run_id | integer | yes |  |
| workflow_id | integer | yes |  |
| name | string | yes |  |
| mode | string | yes |  |
| state | string | yes |  |
| is_completed | boolean | yes |  |
| revision | integer | yes |  |
| initial_context | object or null | no |  |
| gathered_context | object or null | no |  |
| annotations | object or null | no |  |
| session_data | object | yes |  |
| checkpoint | object | yes |  |
| created_at | string | yes | format: "date-time" |
| updated_at | string or null | no |  |

### Response 404

Not found

### Response 422

Validation Error

application/json: HTTPValidationError (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| detail | array of ValidationError (object) | no |  |

## OpenAPI

````yaml api-reference/openapi.json post /api/v1/workflow/{workflow_id}/text-chat/sessions
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/workflow/{workflow_id}/text-chat/sessions:
    post:
      tags:
        - main
        - workflow-text-chat
      summary: Create Text Chat Session
      operationId: create_text_chat_session_api_v1_workflow__workflow_id__text_chat_sessions_post
      parameters:
        - name: workflow_id
          in: path
          required: true
          schema:
            type: integer
            title: Workflow Id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTextChatSessionRequest"
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowRunTextSessionResponse"
        "404":
          description: Not found
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    CreateTextChatSessionRequest:
      properties:
        name:
          anyOf:
            - type: string
            - type: "null"
          title: Name
        initial_context:
          anyOf:
            - additionalProperties: true
              type: object
            - type: "null"
          title: Initial Context
        annotations:
          anyOf:
            - additionalProperties: true
              type: object
            - type: "null"
          title: Annotations
      type: object
      title: CreateTextChatSessionRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    WorkflowRunTextSessionResponse:
      properties:
        workflow_run_id:
          type: integer
          title: Workflow Run Id
        workflow_id:
          type: integer
          title: Workflow Id
        name:
          type: string
          title: Name
        mode:
          type: string
          title: Mode
        state:
          type: string
          title: State
        is_completed:
          type: boolean
          title: Is Completed
        revision:
          type: integer
          title: Revision
        initial_context:
          anyOf:
            - additionalProperties: true
              type: object
            - type: "null"
          title: Initial Context
        gathered_context:
          anyOf:
            - additionalProperties: true
              type: object
            - type: "null"
          title: Gathered Context
        annotations:
          anyOf:
            - additionalProperties: true
              type: object
            - type: "null"
          title: Annotations
        session_data:
          additionalProperties: true
          type: object
          title: Session Data
        checkpoint:
          additionalProperties: true
          type: object
          title: Checkpoint
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: "null"
          title: Updated At
      type: object
      required:
        - workflow_run_id
        - workflow_id
        - name
        - mode
        - state
        - is_completed
        - revision
        - session_data
        - checkpoint
        - created_at
      title: WorkflowRunTextSessionResponse
````