Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
AI

Get conversation

Retrieve a conversation with its full message history — alternating user and assistant turns. Each assistant turn carries the originating jobId and an omniChatUrl deep link.

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
get/v1/ai/conversations/{conversationId}

Path parameters

conversationIdstring uuid required

The unique identifier of the conversation

Response

Conversation retrieved successfully

idstring uuid required

The unique identifier for this conversation.

userIdstring uuid required

The user ID who created this conversation.

organizationIdstring uuid required

The organization that owns this conversation.

createdAtstring date-time required

When the conversation was created.

updatedAtstring date-time required

When the conversation was last modified.

Example response

{
  "id": "660e8400-e29b-41d4-a716-446655440001",
  "userId": "990e8400-e29b-41d4-a716-446655440004",
  "organizationId": "880e8400-e29b-41d4-a716-446655440003",
  "createdAt": "2025-01-15T10:00:00.000Z",
  "updatedAt": "2025-01-15T10:01:30.000Z",
  "messages": [
    {
      "role": "user",
      "content": "What are the top 5 products by revenue?",
      "timestamp": "2025-01-15T10:00:00.000Z",
      "jobId": "550e8400-e29b-41d4-a716-446655440000",
      "omniChatUrl": "https://my-org.omni.co/chat/660e8400-e29b-41d4-a716-446655440001"
    }
  ]
}