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

ASAPP Conversations API

Operations to send conversational inputs to ASAPP AI services

ASAPP Conversations API is one of 14 APIs that ASAPP 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.

This API exposes 9 operations across 7 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.sandbox.asapp.com, https://api.test.asapp.com.

9 operations 7 paths 24 schemas 5 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.asapp.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

ASAPP Conversations API declares 2 security schemes for authenticating requests. An API key is passed in the header as asapp-api-id (API-ID). An API key is passed in the header as asapp-api-secret (API-Secret).

Paths & Operations 9

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

Conversations 9

Operations to send conversational inputs to ASAPP AI services

POST
/conversation/v1/conversations
Create or update a conversation
createOrUpdateConversation body → 200400401403404409413422
GET
/conversation/v1/conversations
List conversations
getConversations 1 param → 200400401403404422429503
GET
/conversation/v1/conversations/{conversationId}
Retrieve a conversation
getConversation 1 param → 200400401403404422429503
POST
/conversation/v1/conversations/{conversationId}/messages
Create a message
createMessage 1 param body → 200400401403404409413422
GET
/conversation/v1/conversations/{conversationId}/messages
List messages
getMessages 1 param → 200400401403404409413422
GET
/conversation/v1/conversations/{conversationId}/messages/{messageId}
Retrieve a message
getMessage 2 params → 200400401403404409413422
POST
/conversation/v1/conversations/{conversationId}/messages/batch
Create multiple messages
createBatchMessages 1 param body → 200400401403404409413422
GET
/conversation/v1/conversation/messages
List messages with an externalId
getMessagesByExternalId 1 param → 200400401403404409413422
POST
/conversation/v1/conversations/{conversationId}/authenticate
Authenticate a user in a conversation
postAuthenticate 1 param body → 204400401403404422429503

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are TimeBasedConversation (6 properties), GetMessageResponse (5 properties), Conversation (5 properties), DefaultErrorDetails (3 properties). Each schema is shown below with its type and property counts.

DefaultErrorResponse
object
Default error response
1 property
MessagesResponse
object
Response for messages
1 property
DefaultErrorDetails
object
Error details
3 properties 2 required
Conversation
object
Represents a conversation between an agent and a customer.
5 properties 2 required
UnprocessableEntity
object
Unprocessable Entity response
1 property
BatchMessages
object
A batch of messages for conversation
1 property
ConflictResponse
object
Conflict response
1 property
Participant
object
Represents a participant in the conversation.
2 properties 2 required
GetMessagesResponse
object
Response for GetMessages
1 property
ConversationResponse
object
Response for conversation
1 property
TimeBasedConversation
object
Conversation between an agent and a customer that requires a timestamp of creation
6 properties 3 required
ForbiddenResponse
object
Forbidden response
1 property
Conversations
object
A list of conversations
1 property
GetMessageResponse
object
Response for GetMessage
5 properties 5 required
Message
object
Represents a single message within a conversation.
3 properties 3 required
ParticipantRole
string
A participant role, usually the customer or an agent for human participants. System participant is also allowed but keep in mind that this role won't be consid…
NotFoundResponse
object
Not Found response
1 property
RequestEntityTooLargeResponse
object
Request Entity Too Large response
1 property
AuthObject
object
Contains authentication information for a customer in a conversation.
3 properties 2 required
UnauthorizedResponse
object
Unauthorized response
1 property
BatchMessagesResponse
object
Response for batch messages
TooManyRequestsResponse
object
Too Many Requests response
1 property
BadRequestResponse
object
Bad request response
1 property
ServiceUnavailableResponse
object
Service Unavailable response
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

asapp-conversations-api-openapi.yml Raw ↑

Other APIs ASAPP publishes across the network.

ASAPP AutoCompose API
ASAPP AutoSummary API
ASAPP AutoTranscribe API
ASAPP AutoTranscribe Media Gateway API
ASAPP Configuration API
ASAPP Disengage API
ASAPP Engage API
ASAPP File Exporter API
ASAPP GenerativeAgent API
ASAPP Health Check API
ASAPP Knowledge Base API
ASAPP Metadata API
Where this information came from

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