Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chat Conversations API

The Conversations API from Chat — 2 operation(s) for conversations.

This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.example.com/v1/chat.

3 operations 2 paths 1 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.example.com/v1/chat
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Chat Conversations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Conversations 3
GET
/conversations
List conversations
listConversations 2 params → 200
POST
/conversations
Create a conversation
createConversation body → 201
GET
/conversations/{conversationId}
Get a conversation
getConversation 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Conversation (5 properties). Each schema is shown below with its type and property counts.

Conversation
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chat-conversations-api-openapi.yml Raw ↑