Skip to main content
GET
/
v1
/
ai
/
conversations
/
{conversationId}
Get conversation
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/ai/conversations/{conversationId} \
  --header 'Authorization: Bearer <token>'
{
  "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:05:00.000Z",
  "messages": [
    {
      "role": "user",
      "content": "What are the top 5 products by revenue?",
      "timestamp": "2025-01-15T10:00:00.000Z"
    },
    {
      "role": "assistant",
      "content": "### Top 5 Products by Revenue\n\n1. **Sunglasses** - $678,994\n2. **Jeans** - $475,072\n3. **T-Shirt** - $320,150\n4. **Sneakers** - $289,033\n5. **Hat** - $201,487",
      "timestamp": "2025-01-15T10:01:30.000Z",
      "jobId": "550e8400-e29b-41d4-a716-446655440000",
      "omniChatUrl": "https://my-org.omni.co/chat/660e8400-e29b-41d4-a716-446655440001"
    },
    {
      "role": "user",
      "content": "Show me revenue by month for sunglasses",
      "timestamp": "2025-01-15T10:03:00.000Z"
    },
    {
      "role": "assistant",
      "content": "### Sunglasses Revenue by Month\n\n- January: $52,430\n- February: $48,221\n- March: $61,992",
      "timestamp": "2025-01-15T10:05:00.000Z",
      "jobId": "550e8400-e29b-41d4-a716-446655440010",
      "omniChatUrl": "https://my-org.omni.co/chat/660e8400-e29b-41d4-a716-446655440001"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
conversationId
string<uuid>
required

The unique identifier of the conversation

Response

Conversation retrieved successfully

​
id
string<uuid>
required

The unique identifier for this conversation.

Example:

"660e8400-e29b-41d4-a716-446655440001"

​
userId
string<uuid>
required

The user ID who created this conversation.

Example:

"990e8400-e29b-41d4-a716-446655440004"

​
organizationId
string<uuid>
required

The organization that owns this conversation.

Example:

"880e8400-e29b-41d4-a716-446655440003"

​
createdAt
string<date-time>
required

When the conversation was created.

Example:

"2025-01-15T10:00:00.000Z"

​
updatedAt
string<date-time>
required

When the conversation was last modified.

Example:

"2025-01-15T10:01:30.000Z"

​
messages
object[]
required

Ordered list of messages in the conversation, alternating between user and assistant turns.