Chat

Topic-level profile capturing the Chat API category in the API Evangelist network. This profile defines a reference vocabulary and a generic OpenAPI shape for chat APIs that manage conversations, messages, and participants, and is used as a baseline when cataloguing chat platform APIs (such as Slack, Discord, Microsoft Teams, Twilio Conversations, and conversational AI platforms) into the broader catalogue.

1 APIs 0 Features

ChatConversational AIConversationsCustomer SupportMessagingReal-time

APIs

Reference Chat API

Reference REST API shape for chat platforms covering conversation lifecycle (create/list/get), message send and history, participant management, and typing indicator events. Int...

Collections

Reference Chat API

OPEN

Pricing Plans

Chat Plans Pricing

3 plans

PLANS

Rate Limits

Chat Rate Limits

5 limits

RATE LIMITS

FinOps

Chat Finops

FINOPS

Semantic Vocabularies

Chat Context

0 classes · 3 properties

JSON-LD

Resources

Sources

opencollection: 1.0.0
info:
  name: Reference Chat API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Conversations
    type: folder
  items:
  - info:
      name: List conversations
      type: http
    http:
      method: GET
      url: https://api.example.com/v1/chat/conversations
      params:
      - name: cursor
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
    docs: List conversations
  - info:
      name: Create a conversation
      type: http
    http:
      method: POST
      url: https://api.example.com/v1/chat/conversations
      body:
        type: json
        data: '{}'
    docs: Create a conversation
  - info:
      name: Get a conversation
      type: http
    http:
      method: GET
      url: https://api.example.com/v1/chat/conversations/:conversationId
      params:
      - name: conversationId
        value: ''
        type: path
    docs: Get a conversation
- info:
    name: Messages
    type: folder
  items:
  - info:
      name: List messages in a conversation
      type: http
    http:
      method: GET
      url: https://api.example.com/v1/chat/conversations/:conversationId/messages
      params:
      - name: conversationId
        value: ''
        type: path
      - name: cursor
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
    docs: List messages in a conversation
  - info:
      name: Send a message
      type: http
    http:
      method: POST
      url: https://api.example.com/v1/chat/conversations/:conversationId/messages
      params:
      - name: conversationId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Send a message
- info:
    name: Participants
    type: folder
  items:
  - info:
      name: List participants
      type: http
    http:
      method: GET
      url: https://api.example.com/v1/chat/conversations/:conversationId/participants
      params:
      - name: conversationId
        value: ''
        type: path
    docs: List participants
  - info:
      name: Add a participant
      type: http
    http:
      method: POST
      url: https://api.example.com/v1/chat/conversations/:conversationId/participants
      params:
      - name: conversationId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Add a participant
bundled: true