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 Participants API

The Participants API from Chat — 1 operation(s) for participants.

This API exposes 2 operations across 1 path, 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.

2 operations 1 paths 1 schemas 1 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 Participants API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 2

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

Participants 2
GET
/conversations/{conversationId}/participants
List participants
listParticipants 1 param → 200
POST
/conversations/{conversationId}/participants
Add a participant
addParticipant 1 param body → 201

Schemas 1

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

Participant
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chat-participants-api-openapi.yml Raw ↑