Finish a conversation
Conclude a conversation and asynchronously initiate post-conversation analysis. A conversation created with is_test gets no analysis.
This endpoint should only be called on a started, non-finished conversation. It can only be called when the previous Start a conversation and Interact with a conversation calls have finished.
If the conversation has no messages, the conversation is deleted.
It's possible for some conversations to automatically finish during an Interact with a conversation call (for instance, if the user explicitly sends a message indicating that they're done with the conversation). In that case, this endpoint shouldn't be called, as the Interact with a conversation endpoint automatically wraps up the conversation.
Permissions
This endpoint requires the following permissions:
- User:UpdateUserInfo on the user who started the conversation.
- Conversation:FinishConversation on the conversation.
Request
- Base URLhttps://api.amigo.ai
- AuthHTTP bearer and API key in header X-ORG-ID and HTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The identifier of the conversation to finish.
Headers
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
Response
Succeeded.
Changes
No operation changes recorded.