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

# Send a message

> Send a customer's message to an agent and get its reply. Omit `conversation_id` to start a conversation; pass the one you got back to continue it. Billed as a chat reply.



## OpenAPI

````yaml /api-reference/openapi.json post /agents/{agent_id}/chat
openapi: 3.1.0
info:
  title: Wiredesk API
  version: 1.0.0
  description: >-
    Read and change a Wiredesk workspace: agents, conversations, contacts, leads
    and knowledge, and talk to an agent. Authenticate with an API key from
    Developers → API keys. Every response carries an x-request-id header, which
    Developers → Logs finds the request by.
servers:
  - url: https://wiredesk.ai/api/v1
security:
  - bearerAuth: []
tags:
  - name: Agents
    description: 'The workspace''s agents: their name, greeting, instructions and channels.'
  - name: Chat
    description: >-
      Send a customer's message to an agent and get its reply, without the chat
      widget.
  - name: Knowledge
    description: >-
      What an agent answers from: pasted text and websites, and the sources
      added in the dashboard.
  - name: Conversations
    description: Conversations on every channel, and their transcripts.
  - name: Contacts
    description: The people the agents talk to, by phone number, email or your own id.
  - name: Leads
    description: Leads the agents captured.
  - name: Onboarding
    description: >-
      Agent-first onboarding: an AI agent builds a trial agent from a website,
      and a person claims it.
paths:
  /agents/{agent_id}/chat:
    post:
      tags:
        - Chat
      summary: Send a message
      description: >-
        Send a customer's message to an agent and get its reply. Omit
        `conversation_id` to start a conversation; pass the one you got back to
        continue it. Billed as a chat reply.
      operationId: send_message
      parameters:
        - name: agent_id
          in: path
          required: true
          schema:
            type: string
          description: The agent's id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: string
                  maxLength: 2000
                  description: What the customer says.
                conversation_id:
                  type: string
                  description: Continue this conversation.
                user_id:
                  type: string
                  maxLength: 64
                  description: >-
                    Your id for the person. Their conversations share one
                    contact.
                name:
                  type: string
                  maxLength: 120
                  description: The person's name, if you know it.
              required:
                - message
      responses:
        '200':
          description: The reply
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/ChatResult'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '402':
          description: Spend cap reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '403':
          description: Read-only key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '502':
          description: Upstream failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '503':
          description: Not configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
components:
  schemas:
    ChatResult:
      type: object
      properties:
        conversation_id:
          type: string
        user_message:
          $ref: '#/components/schemas/Message'
        reply:
          anyOf:
            - $ref: '#/components/schemas/Message'
            - type: 'null'
        handover_state:
          anyOf:
            - type: string
              enum:
                - requested
                - active
                - unanswered
            - type: 'null'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - spend_cap_reached
                - read_only_key
                - channel_disabled
                - knowledge_full
                - not_found
                - method_not_allowed
                - already_exists
                - conflict
                - rate_limited
                - internal_error
                - upstream_error
                - not_configured
            message:
              type: string
          additionalProperties: true
    Message:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
          const: message
        conversation_id:
          type: string
        role:
          type: string
          enum:
            - user
            - agent
            - human_agent
        text:
          type: string
        created_at:
          type: string
          format: date-time
  headers:
    RequestId:
      description: >-
        A unique id for this request, on every response including errors.
        Developers → Logs finds the request by it; quote it to support.
      schema:
        type: string
        format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key, `wd_...`.

````

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