Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adapter conversations API

The conversations API from Adapter — 11 operation(s) for conversations.

Adapter conversations API is one of 26 APIs that Adapter 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 14 operations across 11 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against the base URL https://api.adapter.com.

14 operations 11 paths 14 schemas 1 DELETE6 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.adapter.com
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Adapter conversations API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (HTTPBasic). It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 14

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

conversations 14
GET
/users/me/conversations/models
Get Available Models
get_available_models_users_me_conversations_models_get → 200401409403500
POST
/users/me/conversations
Create Conversation
create_conversation_users_me_conversations_post body → 200401409403500422
GET
/users/me/conversations
List Conversations
list_conversations_users_me_conversations_get 3 params → 200401409403500422
POST
/users/me/conversations/{conversation_id}/completion
Send Message
send_message_users_me_conversations__conversation_id__completion_post 2 params body → 200401409403500422
GET
/users/me/conversations/{conversation_id}
Get Conversation
get_conversation_users_me_conversations__conversation_id__get 1 param → 200401409403500422
PATCH
/users/me/conversations/{conversation_id}
Update Conversation
update_conversation_users_me_conversations__conversation_id__patch 1 param body → 200401409403500422
DELETE
/users/me/conversations/{conversation_id}
Delete Conversation
delete_conversation_users_me_conversations__conversation_id__delete 1 param → 204401409403500422
GET
/users/me/conversations/{conversation_id}/messages/{message_id}/status
Get Message Status
get_message_status_users_me_conversations__conversation_id__messages__message_id__status_get 2 params → 200401409403500422
GET
/users/me/conversations/{conversation_id}/stream/{session_id}
Reconnect To Stream
reconnect_to_stream_users_me_conversations__conversation_id__stream__session_id__get 2 params → 200401409403500422
POST
/users/me/conversations/{conversation_id}/stop_response
Stop Response
stop_response_users_me_conversations__conversation_id__stop_response_post 1 param body → 200401409403500422
GET
/users/me/conversations/{conversation_id}/jobs
Get Conversation Jobs
get_conversation_jobs_users_me_conversations__conversation_id__jobs_get 1 param → 200401409403500422
POST
/users/me/conversations/{conversation_id}/nba
Generate Next Best Action
generate_next_best_action_users_me_conversations__conversation_id__nba_post 2 params → 200401409403500422
POST
/users/me/conversations/{conversation_id}/feedback
Submit Conversation Feedback
submit_conversation_feedback_users_me_conversations__conversation_id__feedback_post 1 param body → 200401409403500422
POST
/users/me/conversations/{conversation_id}/messages/{message_id}/feedback
Submit Message Feedback
submit_message_feedback_users_me_conversations__conversation_id__messages__message_id__feedback_post 2 params body → 200401409403500422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are FileAttachment (11 properties), ConversationSummary (6 properties), ConversationConfig (5 properties), ConversationResponse (5 properties). Each schema is shown below with its type and property counts.

HTTPValidationError
object
1 property
ConversationConfig
object
5 properties
NextBestActionSuggestion
object
Suggestion details for next best action
4 properties
FeedbackRequest
object
User feedback on a conversation or message
2 properties 1 required
ConversationSummary
object
A simplified version for list views
6 properties 4 required
CompletionRequest
object
Send message to existing conversation
4 properties 1 required
ValidationError
object
5 properties 3 required
StopResponseRequest
object
Stop AI message generation
1 property 1 required
CreateConversationRequest
object
5 properties 1 required
UpdateConversationRequest
object
Request to update a conversation
2 properties
FileAttachment
object
11 properties 2 required
ConversationResponse
object
5 properties 4 required
NextBestActionResponse
object
Response from next best action generation
4 properties
FeedbackResponse
object
Response after submitting feedback
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adapter-conversations-api-openapi.yml Raw ↑

Other APIs Adapter publishes across the network.

Adapter Adapter API API
Adapter assets API
Adapter auth API
Adapter Docs API
Adapter Imessage API
Adapter knowledge API
Adapter life API
Adapter Line API
Adapter location API
Adapter management API
Adapter Oauth API
Adapter oauth-connect API