TalkJS Conversations API
Create, update, list, and delete conversations.
TalkJS Conversations API is one of 6 APIs that TalkJS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 6 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://api.talkjs.com/v1/{appId}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
TalkJS Conversations API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— A TalkJS secret key or a short-lived JWT with admin claims, sent as "Authorization: Bearer ".
Paths & Operations 6
Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Create, update, list, and delete conversations.
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Message (14 properties), Conversation (10 properties), Participant (5 properties), ConversationInput (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from TalkJS 5
Other APIs TalkJS publishes across the network.