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

Amigo Conversation API

The Conversation API from Amigo — 9 operation(s) for conversation.

Amigo Conversation API is one of 72 APIs that Amigo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Conversation. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 9 paths, and defines 72 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 5 base URLs: https://api.amigo.ai, https://internal-api.amigo.ai, https://api-eu-central-1.amigo.ai, https://api-ap-southeast-2.amigo.ai, https://api-ca-central-1.amigo.ai.

10 operations 9 paths 72 schemas 4 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.amigo.ai
Authentication
HTTP Bearer, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 3

Amigo Conversation API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer-Authorization). An API key is passed in the header as X-ORG-ID (Bearer-Authorization-Organization). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • Bearer-Authorization — Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the [SignInWithAPIKey](sign-in-wi…
  • Bearer-Authorization-Organization — An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is ma…
  • Basic — The username should be set to {orgid}{userid}, and the password should be the Amigo issued JWT token that identifies the user.

Paths & Operations 10

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

Conversation 10
POST
/v1/{organization}/conversation/
Create a conversation
create-conversation 5 params body → 201422404400409401403503
GET
/v1/{organization}/conversation/
Get conversations
get-conversations 11 params → 200422401403503429
GET
/v1/{organization}/conversation/{conversation_id}/messages/
Get conversation messages
get-conversation-messages 10 params → 200422404401403503429
POST
/v1/{organization}/conversation/{conversation_id}/finish/
Finish a conversation
finish-conversation 4 params → 204404422409400401403503
POST
/v1/{organization}/conversation/{conversation_id}/interaction/{interaction_id}/recommend_responses
Recommend responses for interaction
recommend-responses-for-interaction 5 params body → 200422404400401403503429
GET
/v1/{organization}/conversation/{conversation_id}/interaction/{interaction_id}/insights
Get interaction insights
get-interaction-insights 5 params → 200404422401403503429
POST
/v1/{organization}/conversation/{conversation_id}/interact
Interact with a conversation
interact-with-conversation 9 params body → 200422404409401403503415
GET
/v1/{organization}/conversation/{conversation_id}/messages/{message_id}/source
Retrieve message source
retrieve-message-source 6 params → 200404400422401403503429
POST
/v1/{organization}/conversation/conversation_starter
Generate conversation starters for a service
generate-conversation-starter 3 params body → 200404422401403503429
POST
/v1/{organization}/conversation/{conversation_id}/tags/
Modify tags of a conversation
modify-tags-of-conversation 4 params body → 204422404400401403503429

Schemas 72

The contract defines 72 schemas that model the data the API accepts and returns. The most detailed are ConversationInstance (11 properties), src__app__endpoints__conversation__get_interaction_insights__Response (9 properties), MessageInstance (7 properties), ToolCallEndedEvent (7 properties). Each schema is shown below with its type and property counts.

StrippedNonemptyString___w__s______
string
amigo_lib__pydantic__base_model__StrippedNonemptyString__4
string
ActionTooLongEvent
object
Indicating that a previously-started action of the agent is taking too long. This event supplies a filler text that can be displayed while waiting for the acti…
3 properties 2 required
NavigateStateMachineAnnotationStateAnnotationRetrievedEvent
object
Indicating that the agent has retrieved the annotation in the current annotation state.
2 properties 1 required
UserMessageAvailableEvent
object
Emitted when the full text of the user message is available. In particular, for voice messages, this event is emitted when the transcription of the user messag…
3 properties 2 required
CheckIfActiveMemoryNeededAgentActionEvent
object
2 properties 1 required
NavigateStateMachineExitConditionSelectedEvent
object
Indicating that the agent has selected an exit condition from the current action or decision state.
4 properties 3 required
ExtractActiveMemoriesAgentActionEvent
object
2 properties 1 required
src__app__endpoints__conversation__recommend_responses_for_interaction__Request
object
1 property
InteractionCompleteEvent
object
Emitted when the interaction is complete and committed to database. This event is only emitted after all NewMessageEvents are emitted.
5 properties 4 required
NavigateStateMachineActionStateActionSelectedEvent
object
Indicating that the agent has selected an action from the current state.
2 properties 1 required
Format
string
JumpbackStateTransitionLog
object
5 properties 4 required
GenerateToolParamsDesignatedToolRetrievedEvent
object
3 properties 2 required
ConversationInstance
object
11 properties 11 required
Prompt
object
2 properties 2 required
WorkingMemory
object
2 properties 2 required
src__app__endpoints__conversation__get_conversation_messages__Response
object
3 properties 3 required
src__app__endpoints__conversation__generate_conversation_starter__Response
object
1 property 1 required
CurrentAgentActionEvent
object
Emitted when an agent is about to perform an action that aids in the generation of the response. This is emitted before any NewMessageEvent is emitted.
2 properties 1 required
UserMessageAudioConfig
NewMessageEvent
object
Emitted when a new piece of the agent message is available.
6 properties 5 required
DecisionStateTransitionLog
object
7 properties 6 required
src__app__amigo__service__conversation__Action
NavigateStateMachineDecisionStateDecisionStartedEvent
object
Indicating that the agent has started making a decision in the current decision state.
1 property
ConversationEvent
ConversationCreatedEvent
object
Emitted when the conversation is created.
2 properties 1 required
StrippedNonemptyString___w__s_____
string
StateTransitionLog
ToolCallStartedEvent
object
Indicating that the agent has started executing a tool.
5 properties 4 required
ReflectionStateTransitionLog
object
7 properties 6 required
EngageUserDynamicBehaviorOverrideEvent
object
Indicating that the agent has merged the dynamic behavior set's instructions with the instructions from the current state.
3 properties 2 required
src__app__endpoints__conversation__interact_with_conversation__Response
GenerateToolParamsEvent
src__app__endpoints__conversation__get_conversations__Response
object
3 properties 3 required
NavigateStateMachineToolCallStateToolOutputAvailableEvent
object
Indicating that the agent has received the tool output in the current tool call state.
6 properties 5 required
NavigateStateMachineRecallStateDynamicQueriesGeneratedEvent
object
Indicating that the agent has generated dynamic queries in the current the recall state.
3 properties 2 required
src__app__endpoints__conversation__create_conversation__Response
ErrorEvent
object
Emitted when there is an error during the stream. This event could be emitted even if the request returns with a 200. If received before an interaction-complet…
3 properties 2 required
RecallStateTransitionLog
object
6 properties 5 required
ActionStateTransitionLog
object
7 properties 6 required
NavigateStateMachineRecallStateStaticQueriesRetrievedEvent
object
Indicating that the agent has retrieved the static queries in the current the recall state.
2 properties 1 required
SelectDynamicBehaviorCompletedEvent
object
3 properties 2 required
SelectDynamicBehaviorVectorGeneratedEvent
object
1 property
NavigateStateMachineDynamicBehaviorOverrideEvent
object
Indicating that the agent has merged the dynamic behavior set's instructions with the instructions from the current state.
3 properties 2 required
SelectDynamicBehaviorRelevanceRetrievalCompletedEvent
object
1 property
NavigateStateMachineAgentActionEvent
NavigateStateMachineReflectionStateReflectionGeneratedEvent
object
Indicating that the agent has generated the reflection in the current reflection state.
2 properties 1 required
NavigateStateMachineRecallStateActiveMemoryRetrievedEvent
object
Indicating that the agent has retrieved the active memory in the current the recall state.
2 properties 1 required
MessageType
string
LLMConfig-Output
object
2 properties 1 required
VersionSetInfo
object
4 properties 4 required
src__app__endpoints__conversation__get_interaction_insights__Response
object
9 properties 9 required
MP3UserMessageAudioConfig
object
1 property
PCMUserMessageAudioConfig
object
4 properties 3 required
src__app__endpoints__conversation__create_conversation__Request
object
5 properties 1 required
src__app__endpoints__conversation__recommend_responses_for_interaction__Response
object
1 property 1 required
SelectDynamicBehaviorAgentActionEvent
ToolCallStateTransitionLog
object
7 properties 6 required
NavigateStateMachineStateTransitionedEvent
object
Indicating that the agent has transitioned to a new state.
5 properties 4 required
EngageUserMessageFragmentGeneratedEvent
object
Indicating that the agent has generated a fragment of the agent response.
4 properties 3 required
ToolCallLog
object
6 properties 6 required
EngageUserAgentActionEvent
amigo_lib__pydantic__base_model__StrippedNonemptyString__1
string
NavigateStateMachineReflectionStatePromptRetrievedEvent
object
Indicating that the agent has retrieved the prompt in the current reflection state.
2 properties 1 required
src__app__endpoints__conversation__generate_conversation_starter__Request
object
6 properties 5 required
PostAnalysisType
string
AnnotationStateTransitionLog
object
6 properties 5 required
GenerateToolParamsDesignatedToolCallParamsGeneratedEvent
object
4 properties 3 required
src__app__endpoints__conversation__modify_tags_of_conversation__Request
object
2 properties
MessageInstance
object
7 properties 7 required
ToolCallEndedEvent
object
Indicating that the agent has finished executing a tool.
7 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-conversation-api-openapi.yml Raw ↑

Other APIs Amigo publishes across the network.

Amigo Account API
Amigo Admin API
Amigo Agent Definitions API
Amigo Agent Runs API
Amigo Agents API
Amigo Analytics API
Amigo API Keys API
Amigo Audit API
Amigo Auth API
Amigo Billing API
Amigo Calls API
Amigo Command Center API
Where this information came from

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