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

Ada Conversations API

The conversations API from Ada — 9 operation(s) for conversations.

Ada Conversations API is one of 29 APIs that Ada publishes on the APIs.io network.

Tagged areas include Conversations and Messaging. The published artifact set on APIs.io includes API documentation.

This API exposes 11 operations across 9 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://example.ada.support/api, https://example.ada.support.

11 operations 9 paths 48 schemas 4 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://example.ada.support
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Ada Conversations API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 4 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

conversations 11
GET
/v2/export/conversations
Return conversations matching the parameters
get-conversations 6 params → 200400401403404429500
GET
/data_api/v1.4/conversations
Return conversations matching the parameters
return-conversations-matching-the-parameters 6 params → 200400408422429500502503
POST
/v2/conversations/email/
Start a conversation over Ada's email channel
create-email-conversation 1 param body → 200400401422429500
POST
/v2/conversations/
Create a new conversation
create-conversation 1 param body → 201400401404429500
GET
/v2/conversations/{conversation_id}/
Get a conversation
get-conversation-by-id 2 params → 200400401404429500
PATCH
/v2/conversations/{conversation_id}/
Update a conversation
patch-conversation-by-id 2 params body → 200400401404429500
GET
/v2/conversations/{conversation_id}/messages/
Get conversation messages
fetch-conversation-messages-by-id 4 params → 200400401404429500
POST
/v2/conversations/{conversation_id}/messages/
Create a new message
create-message 2 params body → 201400401404429500
POST
/v2/conversations/{conversation_id}/end/
End a conversation
end-conversation 2 params → 200400401404429500
POST
/v2/conversations/{conversation_id}/end-handoff/
End Handoff
end-handoff 2 params → 200404422500
POST
/v2/conversations/{conversation_id}/attachments/
Upload a file attachment
upload-attachment 2 params body → 201400401404429500

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are Conversation (37 properties), Conversation_2 (31 properties), EmailConversationCreateRequest (7 properties), Conversation_3 (7 properties). Each schema is shown below with its type and property counts.

ConversationsResponseMeta
object
1 property
ConversationCsat
object
Object of customer satisfaction survey data for this conversation
ConversationUsedCoachingItems
object
5 properties
ConversationClassificationsItems
object
3 properties
ConversationMetavariables
object
Object of metavariables and their values active during this conversations
ConversationClassificationsItemsIntentsItems
object
3 properties
ErrorsErrorsItems
object
3 properties 2 required
Errors
object
1 property 1 required
ConversationsResponse
object
2 properties
ConversationUsedArticlesItems
object
4 properties
ConversationUsedPlaybooksItems
object
4 properties
Conversation
object
37 properties
ConversationVariables
object
Object of autocapture and global variables and their values last active during this conversations
ConversationsResponse_2
object
3 properties
Conversation_2
object
31 properties
TextContentType
string
The type of the message
TextContent
object
The content of the text message
2 properties 2 required
MessageCreateRequestContent
The message content
ConversationCreateRequestMetadata
ConversationPatchRequestMetadata
Conversations_endHandoff_Response_200
object
1 property
ConversationPatchRequest
object
1 property 1 required
EmailConversationCreateRequest
object
7 properties 3 required
ConversationStatus
string
The status of the conversation
ConversationMessageAuthor
object
Information about the message author
4 properties 1 required
EmailConversationCreateResponse
object
1 property
MessageLogsType
string
The type of the message
FileContent
object
The content of a file message
4 properties 4 required
Conversations_endConversation_Response_200
object
1 property
MessageCreateRequest
object
2 properties 2 required
MessageLogsAuthor
object
Information about the message author
4 properties
ConversationMessageAuthorRole
string
The author's role
MessageContent
The message content
AttachmentUploadResponse
object
3 properties 3 required
LinkContentType
string
The type of the message
MessageLogsContent
The message content. The structure varies based on the type field. Supported types: text, link, file.
Conversation_3
object
7 properties
FileContentType
string
The type of the message
Message
object
6 properties
MessageList
object
2 properties 2 required
MessageLogs
object
5 properties
PaginationMetadata
object
1 property
MessageLogsAuthorRole
string
The author's role
EmailConversationCreateRequestMetadata
object
Any metadata associated with the conversation, up to 4 KB. All metadata passed through this field will appear as metavariables in your dashboard.
ConversationMetadata
ConversationCreateRequest
object
3 properties 1 required
MessageEvents
LinkContent
object
The content of a standalone link style messages, such as CSAT
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ada-conversations-api-openapi.yml Raw ↑

Other APIs Ada publishes across the network.

Ada End Users API
Ada Integrations API
Ada MCP Server
Ada Audit Log API
Ada Channels API
Ada Custom Instructions API
Ada Delete Chatter Data API
Ada End Users API
Ada Get Deletion Job API
Ada Knowledge API
Ada knowledge > articles API
Ada knowledge > sources API
Where this information came from

This is an independent, third-party profile of Ada 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.