Get conversation
Changed onRetrieve a conversation with its full message history — alternating user and assistant turns. Each assistant turn carries the originating jobId and an omniChatUrl deep link. userId identifies who the conversation belongs to, whether it started in the Omni UI or through the API.
The conversations returned by this API depend on the type of API key being used:
- Organization API keys can access any conversation in the organization
- Personal Access Tokens can only access the authenticating user's conversations
Request
- Base URLhttps://blobsrus.omniapp.co/api
- URLhttps://blobsrus.omniapp.co/api/v1/ai/conversations/{conversationId}
- AuthHTTP bearer
Path parameters
The unique identifier of the conversation
Response
Conversation retrieved successfully
Example response
{
"id": "660e8400-e29b-41d4-a716-446655440001",
"name": "Top products last week",
"userId": "770e8400-e29b-41d4-a716-446655440002",
"createdAt": "2025-01-15T10:00:00.000Z",
"updatedAt": "2025-01-15T10:01:30.000Z",
"messages": [
{
"role": "user",
"text": "What are the top 5 products by revenue?",
"createdAt": "2025-01-15T10:00:00.000Z",
"jobId": "550e8400-e29b-41d4-a716-446655440000",
"omniChatUrl": "https://my-org.omni.co/chat/660e8400-e29b-41d4-a716-446655440001"
}
]
}Changes
- breaking
the response property
//became nullable for the status - breaking
the response property
//became nullable for the status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - info
api operation id
getConversationremoved and replaced withaiConversationDetail - info
the response property
//became required for the status - info
the response property
//became required for the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- breaking