AI

Get conversation

Changed on

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

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/ai/conversations/{conversationId}
  • Auth
    HTTP bearer

Path parameters

conversationIdstring uuid required

The unique identifier of the conversation

Response

Conversation retrieved successfully

idstring uuid required

The unique identifier for this conversation.

namestring nullable required

Conversation title, set by the AI after the first turn. null on brand-new conversations.

userIdstring uuid required

User ID of the person the conversation belongs to.

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",
  "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 getConversation removed and replaced with aiConversationDetail

    • 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