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

Dixa Chatbots API

The Chatbots API from Dixa — 13 operation(s) for chatbots.

Dixa Chatbots API is one of 20 APIs that Dixa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Chatbots. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and rate-limit docs.

This API exposes 13 operations across 13 paths, and defines 78 schemas. It is described by OpenAPI 3.0.3, at version beta.

Requests are made against a single base URL, https://dev.dixa.io.

13 operations 13 paths 78 schemas 4 GET5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
beta
Base URL
https://dev.dixa.io/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Dixa Chatbots API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 13

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

Chatbots 13
POST
/beta/endusers
Create end user
postEndusers body → 201400500
GET
/beta/endusers/{userId}
Get end user
getEndusersUserid 1 param → 200400404500
GET
/beta/endusers/{userId}/conversations
List end user conversations
getEndusersUseridConversations 3 params → 200400404500
PUT
/beta/conversations/{conversationId}/close
Close conversation
putConversationsConversationidClose 1 param body → 204400404
PUT
/beta/conversations/{conversationId}/followup
Followup conversation
putConversationsConversationidFollowup 1 param body → 204400404
PUT
/beta/conversations/{conversationId}/transfer/queue
Transfer conversation
putConversationsConversationidTransferQueue 1 param body → 204400404500
POST
/beta/conversations/{conversationId}/ratings/{ratingId}/submit
Create conversation rating result
postConversationsConversationidRatingsRatingidSubmit 2 params body → 201400500
POST
/beta/conversations/{conversationId}/ratings/offer
Create conversation rating offer
postConversationsConversationidRatingsOffer 1 param body → 201400404500
POST
/beta/conversations
Create conversation
postConversations body → 201400404500
POST
/beta/conversations/import
Import conversation
postConversationsImport body → 201400404500
PUT
/beta/conversations/{conversationId}/claim
Claim conversation
putConversationsConversationidClaim 1 param body → 204400404409
GET
/beta/queues/{queueId}/availability
Get queue availability
getQueuesQueueidAvailability 1 param → 200400409500
GET
/beta/queues/conversation-position/{csid}
Get the position of the conversation in its current queue
getQueuesConversation-positionCsid 1 param → 200400404500

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are EmailConversation (17 properties), ContactFormConversation (17 properties), TwitterConversation (15 properties), ChatConversation (14 properties). Each schema is shown below with its type and property counts.

Closing
object
Triggers the closing of the conversation
2 properties 2 required
Callback
object
4 properties 4 required
CreateEndUserInput
object
10 properties
TransferConversationInput
object
2 properties 1 required
FollowupConversationInput
object
2 properties 1 required
TwitterConversation
object
15 properties 5 required
QueueAvailabilityOutput
object
1 property
ImportConversationOutput
object
1 property 1 required
WhatsAppConversation
object
12 properties 4 required
ConversationLink
Success
object
1 property 1 required
Content
ContactForm
object
5 properties 4 required
Html
object
1 property 1 required
EndUser
object
13 properties 2 required
Markdown
object
1 property 1 required
Assignment
object
2 properties 2 required
CreateEndUserOutput
object
1 property 1 required
Failure
object
1 property 1 required
Queue
object
2 properties 1 required
Chat
object
5 properties 3 required
GetQueuedConversationPositionOutput
object
1 property 1 required
BrowserInfo
object
4 properties 1 required
RatingResult
object
5 properties 2 required
BadRequest
object
1 property 1 required
Conversation
ChatConversation
object
14 properties 4 required
ImportConversationResponse
object
2 properties 1 required
Email
object
5 properties 4 required
ConversationResponse
object
1 property 1 required
OutboundImport
object
6 properties 3 required
EmailForward
object
1 property 1 required
PstnPhoneConversation
object
12 properties 4 required
CreateRatingOfferInput
object
4 properties 1 required
RatingOffer
object
5 properties 4 required
Sms
object
3 properties 3 required
ClaimConversationInput
object
2 properties 1 required
InboundImport
object
5 properties 2 required
CreateRatingResultInput
object
4 properties 1 required
AnonymizedConversation
object
11 properties 5 required
ListEndUserConversationsOutput
object
2 properties
GenericChannel
object
3 properties 2 required
Outbound
object
7 properties 1 required
Text
object
1 property 1 required
UnexpectedError
object
2 properties 2 required
SideConversation
object
1 property 1 required
PartialError
object
1 property 1 required
CreateConversationInput
SmsConversation
object
14 properties 4 required
ThumbsUpOrDown
object
1 property 1 required
Conflict
object
1 property 1 required
FacebookMessengerConversation
object
12 properties 4 required
GenericConversationImport
object
10 properties 4 required
SubmittedRatingResult
ImportMessageInput
FollowUp
object
1 property 1 required
CreateRatingOfferOutput
object
1 property 1 required
MessengerConversation
object
14 properties 4 required
CloseConversationInput
object
1 property
NotFound
object
1 property 1 required
Inbound
object
4 properties 1 required
CreateConversationOutput
object
1 property 1 required
ChannelAvailability
CreateMessageInput
Only Outbound messages are supported for Sms and Whatsapp.
EmailConversation
object
17 properties 7 required
ServerError
object
1 property 1 required
PaginationLinks
object
2 properties
GetEndUserOutput
object
1 property 1 required
ChannelAvailabilityError
CreateRatingResultOutput
object
1 property 1 required
GenericConversation
object
14 properties 4 required
Nps
object
1 property 1 required
File
object
2 properties 1 required
QueuedConversation
object
2 properties 1 required
CustomAttribute
object
4 properties 4 required
ContactFormConversation
object
17 properties 5 required
Csat
object
1 property 1 required
ChannelAvailabilityOutcome

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dixa-chatbots-api-openapi.yml Raw ↑

Other APIs Dixa publishes across the network.

Dixa Agents API
Dixa Analytics API
Dixa Anonymization API
Dixa Business Hours API
Dixa Contact Endpoints API
Dixa Conversations API
Dixa Custom Attributes API
Dixa End Users API
Dixa Internal Notes API
Dixa Knowledge API
Dixa Messages API
Dixa Organization API
Where this information came from

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