How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, at version 1.0.

Requests are made against a single base URL, https://api.talkjs.com/v1/{appId}.

6 operations 4 paths 7 schemas 1 DELETE3 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.talkjs.com/v1/{appId}
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

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.

Conversations 6

Create, update, list, and delete conversations.

GET
/users/{userId}/conversations
List a user's conversations
listUserConversations 3 params → 200401
GET
/conversations
List conversations
listConversations 2 params → 200401
GET
/conversations/{conversationId}
Retrieve a conversation
getConversation 1 param → 200401404
PUT
/conversations/{conversationId}
Create or update a conversation
createOrUpdateConversation 1 param body → 200401429
DELETE
/conversations/{conversationId}
Delete a conversation
deleteConversation 1 param → 200401404
PATCH
/users/{userId}/conversations/{conversationId}
Mark a conversation read or unread for a user
markConversationRead 2 params body → 200401

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.

ConversationList
object
1 property
ConversationInput
object
5 properties
Error
object
2 properties
Custom
object
Custom key-value metadata (string values).
Conversation
object
10 properties
Message
object
14 properties
Participant
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talkjs-conversations-api-openapi.yml Raw ↑

Other APIs TalkJS publishes across the network.

TalkJS Webhooks API
TalkJS Import API
TalkJS Messages API
TalkJS Participants API
TalkJS Users API
Where this information came from

This is an independent, third-party profile of TalkJS Conversations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.