API reference
Get a conversation
GET /v1/conversations/{conversation_id}
One conversation. Add include=transcript for what was said as well, which also needs transcripts:read. Add include=cost for what it cost, which needs billing:read. Needs conversations:read.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
conversation_id |
path | string (uuid) | Yes | |
include |
query | array of Include or null | No | transcript, cost. Repeatable. |
Answer
200 with ConversationWithTranscript.
Errors
Every error is a problem document with a stable code.
| Status | When |
|---|---|
401 |
The key is missing, mistyped, unknown, revoked or expired. |
403 |
The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something. |
404 |
This key reaches no such conversation. |
422 |
Validation Error |
429 |
Too many requests for this key or its organization; see Retry-After. |
500 |
Something went wrong on our side. Quote the request_id to support. |
Examples
#!/bin/sh
# Read a conversation with its transcript
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/conversations/5f0c9a52-7d3e-4b1a-9c8f-6e2d4a0b3c1d?include=transcript" \
-H "Authorization: Bearer $AIGENTLY_API_KEY"
#!/bin/sh
# Read what a conversation cost
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/conversations/5f0c9a52-7d3e-4b1a-9c8f-6e2d4a0b3c1d?include=cost" \
-H "Authorization: Bearer $AIGENTLY_API_KEY"
Try it
Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.