OMomniapp
AI

Get AI conversation with messages

Changed on

Return a conversation with its full message history (alternating user / assistant turns). Used by clients (iOS app, embed widgets) to restore a prior conversation in their UI. Also serves the conversation behind an AI eval run result: pass results[].agentic_job.conversation_id from GET /api/v1/ai/eval/runs/{runId}. Eval conversations do not appear in GET /api/v1/ai/conversations; this endpoint is the only way to read one. For a user-scoped token the conversation must belong to the caller; for an eval run that is the user who created the run. Use an organization API key to read another user's eval transcripts. Eval conversations also require at least QUERIER on the run's model, the same gate as the eval API. Assistant text is retained for 30 days; older conversations return only their user turns. userId is the user ID of the person the conversation belongs to, whether it started in the Omni UI or through the API.

get/api/v1/ai/conversations/{conversationId}

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/ai/conversations/{conversationId}
  • Auth
    HTTP bearer

Path parameters

conversationIdstring uuid required

Response

Conversation with messages in chronological order.

createdAtstring date-time required
idstring uuid required
namestring nullable required
updatedAtstring date-time required
userIdstring uuid required

User ID of the person the conversation belongs to.

Example response

{
  "messages": [
    {
      "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",
      "role": "user",
      "text": "What were our top products last week?"
    }
  ],
  "userId": "770e8400-e29b-41d4-a716-446655440002"
}

Changes