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

# Start a conversation

> Start a conversation; offline capture requires an email. Authorization and resource ownership are evaluated on every request.



## OpenAPI

````yaml /openapi/widget.json post /api/v1/chat/widget/{siteID}/conversations
openapi: 3.1.0
info:
  title: Widget API
  version: 1.0.0
  description: >-
    Embed Writine chat on your own site. These endpoints need no Writine
    account: the widget routes are authorised by your site origin allowlist, and
    the visitor routes by a token issued when a conversation starts.
servers:
  - url: https://api.writine.com
    description: Production
security: []
paths:
  /api/v1/chat/widget/{siteID}/conversations:
    post:
      summary: Start a conversation
      description: >-
        Start a conversation; offline capture requires an email. Authorization
        and resource ownership are evaluated on every request.
      operationId: chat_post__api_v1_chat_widget__siteID__conversations
      parameters:
        - in: path
          name: siteID
          required: true
          schema:
            type: string
            maxLength: 100
        - in: header
          name: Origin
          required: true
          schema:
            type: string
            format: uri
          description: >-
            Must exactly match the website's allowlist. Visitor tokens are bound
            to this origin.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 80
                email:
                  type: string
                  maxLength: 254
                body:
                  type: string
                  maxLength: 8000
                client_id:
                  type: string
                  maxLength: 100
              required:
                - body
                - client_id
              additionalProperties: false
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  result:
                    type: object
                    properties:
                      conversation_id:
                        type: string
                        maxLength: 100
                      visitor_token:
                        type: string
                        maxLength: 256
                      expires_in_seconds:
                        type: integer
                        minimum: 0
                      offline:
                        type: boolean
                    required:
                      - conversation_id
                      - visitor_token
                      - expires_in_seconds
                      - offline
                    additionalProperties: false
                  message:
                    type: string
                    maxLength: 256
                required:
                  - success
                  - result
                  - message
                additionalProperties: false
        '400':
          description: Typed error envelope
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  result:
                    type: object
                    properties:
                      code:
                        type: string
                        maxLength: 256
                    required:
                      - code
                    additionalProperties: false
                  message:
                    type: string
                    maxLength: 256
                required:
                  - success
                  - result
                  - message
                additionalProperties: false
        '401':
          description: Typed error envelope
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  result:
                    type: object
                    properties:
                      code:
                        type: string
                        maxLength: 256
                    required:
                      - code
                    additionalProperties: false
                  message:
                    type: string
                    maxLength: 256
                required:
                  - success
                  - result
                  - message
                additionalProperties: false
        '403':
          description: Typed error envelope
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  result:
                    type: object
                    properties:
                      code:
                        type: string
                        maxLength: 256
                    required:
                      - code
                    additionalProperties: false
                  message:
                    type: string
                    maxLength: 256
                required:
                  - success
                  - result
                  - message
                additionalProperties: false
        '404':
          description: Typed error envelope
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  result:
                    type: object
                    properties:
                      code:
                        type: string
                        maxLength: 256
                    required:
                      - code
                    additionalProperties: false
                  message:
                    type: string
                    maxLength: 256
                required:
                  - success
                  - result
                  - message
                additionalProperties: false
        '409':
          description: Typed error envelope
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  result:
                    type: object
                    properties:
                      code:
                        type: string
                        maxLength: 256
                    required:
                      - code
                    additionalProperties: false
                  message:
                    type: string
                    maxLength: 256
                required:
                  - success
                  - result
                  - message
                additionalProperties: false
        '429':
          description: Typed error envelope
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  result:
                    type: object
                    properties:
                      code:
                        type: string
                        maxLength: 256
                    required:
                      - code
                    additionalProperties: false
                  message:
                    type: string
                    maxLength: 256
                required:
                  - success
                  - result
                  - message
                additionalProperties: false
        '500':
          description: Typed error envelope
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  result:
                    type: object
                    properties:
                      code:
                        type: string
                        maxLength: 256
                    required:
                      - code
                    additionalProperties: false
                  message:
                    type: string
                    maxLength: 256
                required:
                  - success
                  - result
                  - message
                additionalProperties: false
        '503':
          description: Typed error envelope
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  result:
                    type: object
                    properties:
                      code:
                        type: string
                        maxLength: 256
                    required:
                      - code
                    additionalProperties: false
                  message:
                    type: string
                    maxLength: 256
                required:
                  - success
                  - result
                  - message
                additionalProperties: false
      security: []

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.