Messaging API

A template and concept entry for messaging APIs. This represents the pattern and structure for messaging API implementations used in storytelling, training, and knowledge bases.

1 APIs 0 Features

API PatternMessagingTemplate

APIs

Messaging API Messages API

Template Messages API used as a reusable pattern for messaging API design, storytelling, training, and knowledge bases. Models the core operations expected of a generic messages...

Collections

Messaging API Messages API

OPEN

Pricing Plans

Messaging Api Plans Pricing

3 plans

PLANS

Rate Limits

Messaging Api Rate Limits

5 limits

RATE LIMITS

FinOps

Messaging Api Finops

FINOPS

Sources

opencollection: 1.0.0
info:
  name: Messaging API Messages API
  version: 0.1.0
items:
- info:
    name: Messages
    type: folder
  items:
  - info:
      name: Messaging API Retrieves Messages
      type: http
    http:
      method: GET
      url: https://api.example.com/messages
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Returns a list of all messages for the authenticated user.
  - info:
      name: Messaging API Create Message
      type: http
    http:
      method: POST
      url: https://api.example.com/messages
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Creating a new message for sending to a recipient.
  - info:
      name: Messaging API Retrieve Message
      type: http
    http:
      method: GET
      url: https://api.example.com/messages/:messageId
      params:
      - name: messageId
        value: 1725ff48-ab45-4bb5-9d02-88745177dedb
        type: path
        description: The ID of the message to retrieve.
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Returns the details of a specific message.
  - info:
      name: Messaging API Update Message
      type: http
    http:
      method: PUT
      url: https://api.example.com/messages/:messageId
      params:
      - name: messageId
        value: 1725ff48-ab45-4bb5-9d02-88745177dedb
        type: path
        description: The ID of the message to retrieve.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Updates a single message.
  - info:
      name: Messaging API Delete Message
      type: http
    http:
      method: DELETE
      url: https://api.example.com/messages/:messageId
      params:
      - name: messageId
        value: 1725ff48-ab45-4bb5-9d02-88745177dedb
        type: path
        description: The ID of the message to retrieve.
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Deletes a message.
  - info:
      name: Messaging API Send Message
      type: http
    http:
      method: PUT
      url: https://api.example.com/messages/:messageId/send
      params:
      - name: messageId
        value: 1725ff48-ab45-4bb5-9d02-88745177dedb
        type: path
        description: The ID of the message to retrieve.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: api-key
        value: '{{api-key}}'
        placement: header
    docs: Sends a single message.
bundled: true