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

# Reply to a conversation

> Same message grammar as every endpoint (text, template, interactive, media). Out of the WhatsApp 24h window a free-form message is sent as a notification template. By default the reply takes the conversation over (`handover`): the AI agent stops answering, as when a human answers in the Inbox. A user token of an agent (role) cannot answer a conversation assigned to someone else.



## OpenAPI

````yaml /api-reference/v2.0/openapi.json post /conversations/{id}/messages
openapi: 3.1.0
info:
  title: Shortext API
  description: >-
    **Versioning**: every version is a frozen contract. A released version only
    receives additive changes

    (new endpoints, new optional fields, new response fields); anything breaking
    ships in a new version.

    Responses carry `X-Shortext-Api-Version`. When a version is scheduled for
    removal, responses also carry

    `Deprecation` and `Sunset` headers; after the sunset date the version
    answers HTTP 410.

    The list of versions and their status is available at `GET /api/versions`.


    **Responses**: always HTTP 200. Check `success` and `code` (`1000` =
    success), see `ApiEnvelope`.

    On failure, `trace_id` identifies the request for support.


    **Rate limit**: 300 requests per minute per company, shared by all its keys
    and by every API version.

    Responses carry `X-RateLimit-Limit` and `X-RateLimit-Remaining`; beyond the
    limit the API answers

    HTTP 429 with `Retry-After` (seconds) and the usual envelope. Prefer
    webhooks to polling.
  version: '2.0'
servers:
  - url: https://shortext.ny-corp.io/api/v2.0
security: []
tags:
  - name: Agents
    description: Agents
  - name: Knowledge
    description: Knowledge
  - name: Dynamic links
    description: Dynamic links
  - name: Billing
    description: Billing
  - name: Channels
    description: Channels
  - name: Conversations
    description: Conversations
  - name: Account
    description: Account
  - name: Tickets
    description: Tickets
  - name: Templates
    description: Templates
  - name: Hosted sessions
    description: Hosted sessions
  - name: Webhooks
    description: Webhooks
paths:
  /conversations/{id}/messages:
    post:
      tags:
        - Conversations
      summary: Reply to a conversation
      description: >-
        Same message grammar as every endpoint (text, template, interactive,
        media). Out of the WhatsApp 24h window a free-form message is sent as a
        notification template. By default the reply takes the conversation over
        (`handover`): the AI agent stops answering, as when a human answers in
        the Inbox. A user token of an agent (role) cannot answer a conversation
        assigned to someone else.
      operationId: replyToConversation
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplyInput'
      responses:
        '200':
          description: The sent Message
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiEnvelope'
                  - properties:
                      body:
                        $ref: '#/components/schemas/Message'
                    type: object
      security:
        - bearerAuth: []
components:
  schemas:
    ReplyInput:
      required:
        - message
      properties:
        message:
          $ref: '#/components/schemas/MessageInput'
        handover:
          description: >-
            The reply takes the conversation over: the AI agent stops answering.
            Send false for a notification that lets the agent continue.
          type: boolean
          default: true
      type: object
    ApiEnvelope:
      properties:
        success:
          type: boolean
          example: true
        code:
          type: integer
          example: 1000
        message:
          type: string
          example: Request success.
        body:
          description: Endpoint payload, null when there is none
        token:
          description: Present only on authentication routes
          type:
            - string
            - 'null'
        trace_id:
          description: Present only when success is false
          type:
            - string
            - 'null'
      type: object
    Message:
      properties:
        id:
          description: >-
            Public representation of a message (API v2.0): exactly the data of
            the message.* webhooks.
          type: string
          example: msg.XXXXX
        conversation_id:
          type: string
        direction:
          type: string
          enum:
            - inbound
            - outbound
        channel:
          type: string
          enum:
            - whatsapp
            - mail
            - shortext
        channel_id:
          type: string
        contact:
          type: object
        message:
          properties:
            id:
              description: Id on the channel (your own id for Shortext)
              type:
                - string
                - 'null'
            type:
              type: string
              example: text
            content:
              type: object
              example:
                text: Hello
          type: object
        status:
          type: string
        created_at:
          type: string
          format: date-time
      type: object
    MessageInput:
      description: Grammar of a message, the same on every endpoint and version
      required:
        - type
        - content
      properties:
        type:
          type: string
          enum:
            - text
            - template
            - interactive
            - media
        content:
          description: >-
            `text`: `{ text }`. `template`: `{ template_name, language, body?,
            header?, buttons?, category? }`. `interactive`: `{ type, body,
            action, header?, footer? }`. `media`: `{ media_type, media_url,
            caption?, filename?, mime? }` (media_type: image, video, document,
            audio)
          type: object
          example:
            text: Hello, how can I help?
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        Company API key, sent as `Authorization: Bearer <key>`. Create it in the
        dashboard (Developer > API Keys) with the permissions the integration
        needs.
      scheme: bearer

````

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