AgentLine Messages API

openapi: 3.2.0
info:
  title: Agentline Cloud Messages API
  version: 0.3.0
  x-refined-note:
  - x-guidance differs across the merged source definitions and was not carried
  description: 'Operations tagged Messages across 2 of this provider''s published API definitions: agentline.cloud_openapi.json, agentline-cloud-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.agentline.cloud
  description: Production
tags:
- name: Messages
paths:
  /v1/messages:
    post:
      tags:
      - Messages
      summary: Send Message
      description: Send an outbound SMS message from an AI agent's phone number.
      operationId: send_sms
      security:
      - API Key or OAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageSend'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-fern-sdk-group-name:
      - messages
      x-fern-sdk-method-name: send
    get:
      tags:
      - Messages
      summary: List Messages
      description: 'List SMS messages for your AI agents.


        Returns texts received on the agent''s number and stored message history. Optional filters: AI agent or conversation. Each entry includes direction, phone numbers, message body, and delivery status.'
      operationId: list_messages
      security:
      - API Key or OAuth: []
      parameters:
      - name: agent_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter messages by AI agent ID
          title: Agent Id
        description: Filter messages by AI agent ID
      - name: conversation_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter messages by conversation thread ID
          title: Conversation Id
        description: Filter messages by conversation thread ID
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          description: Maximum number of messages to return (1-200)
          default: 50
          title: Limit
        description: Maximum number of messages to return (1-200)
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Number of messages to skip for pagination
          default: 0
          title: Offset
        description: Number of messages to skip for pagination
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-fern-sdk-group-name:
      - messages
      x-fern-sdk-method-name: list
    servers:
    - url: https://api.agentline.cloud
      description: Production
  /v1/messages/conversations:
    get:
      tags:
      - Messages
      summary: List Conversations
      description: 'List SMS conversation threads for your AI agents.


        Threads can be filtered by AI agent and include messages received on the agent''s phone number.'
      operationId: list_conversations
      security:
      - API Key or OAuth: []
      parameters:
      - name: agent_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-fern-sdk-group-name:
      - messages
      x-fern-sdk-method-name: list_conversations
    servers:
    - url: https://api.agentline.cloud
      description: Production
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MessageSend:
      properties:
        agent_id:
          type: string
          title: Agent Id
          description: ID of the AI agent sending the SMS (e.g. 'agt_abc123')
        to_number:
          type: string
          title: To Number
          description: Destination phone number in E.164 format (e.g. '+12125551234')
        body:
          type: string
          title: Body
          description: SMS message text content
        media_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Media Url
          description: URL of media to attach (MMS)
        from_number_id:
          anyOf:
          - type: string
          - type: 'null'
          title: From Number Id
          description: Specific phone number ID to send from; defaults to the agent's assigned number
      type: object
      required:
      - agent_id
      - to_number
      - body
      title: MessageSend
    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
    MessageOut:
      properties:
        id:
          type: string
          title: Id
          description: Message identifier (e.g. 'msg_abc123')
        conversation_id:
          type: string
          title: Conversation Id
          description: Thread this message belongs to; pass to list_messages to read the exchange
        agent_id:
          type: string
          title: Agent Id
          description: AI agent that sent the message
        from_number:
          type: string
          title: From Number
          description: Sending phone number in E.164 format
        to_number:
          type: string
          title: To Number
          description: Destination phone number in E.164 format
        body:
          type: string
          title: Body
          description: SMS text that was sent
        direction:
          type: string
          title: Direction
          description: Always 'outbound' for a sent message
        status:
          type: string
          title: Status
          description: Carrier delivery status at send time (e.g. 'sent', 'queued')
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the message was sent
      type: object
      required:
      - id
      - conversation_id
      - agent_id
      - from_number
      - to_number
      - body
      - direction
      - status
      - created_at
      title: MessageOut
  securitySchemes:
    API_Key_or_OAuth:
      type: http
      description: 'AgentLine API key. Get one via the email OTP flow (POST /v1/auth/otp then POST /v1/auth/verify). Pass as: Authorization: Bearer al_live_... (legacy sk_live_... still works).'
      scheme: bearer
      bearerFormat: API key (al_live_...)
      x-fern-bearer:
        name: apiKey
        env: AGENTLINE_API_KEY
x-refined-from:
- agentline.cloud_openapi.json
- agentline-cloud-openapi.json