Get conversation by id (deprecated)

GET 
/api/v2/conversation

deprecated

This endpoint is obsolete. Please use '/api/v2/agent/{agentCode}/conversation/{conversationId}' instead.

Request

Query Parameters

id uuid
culture string

Use this param to override the culture of the response. Options: - en (default) - es

Responses

200

Success

application/json

Schema

Schema

id stringnullable
name stringnullable
startDate date-time
endDate date-time
messagesJson stringnullable
userIdentifier stringnullable
conversationStarters string[]nullable
useVision boolean
open boolean

messages

object[]

nullable

The conversation messages in chronological order, each with the per-message sections requested via include.

Array [

id uuid

sender stringnullable

type stringnullable

value stringnullable

createdAt date-time

metaAnalysis

object

Meta-analysis produced for the message when the agent has meta-analysis enabled. Free-form: the set of sections depends on the agent's configuration.

property name* any

Meta-analysis produced for the message when the agent has meta-analysis enabled. Free-form: the set of sections depends on the agent's configuration.

tokenUsage

object

promptTokens int32

completionTokens int32

reasoningTokens int32

cacheWriteTokens int32

cacheReadTokens int32

calculatedSystemDefinitionTokens int32

calculatedKnowledgeTokens int32

calculatedVolatileKnowledgeTokens int32

calculatedUserMessageTokens int32

calculatedMessagesTokens int32

calculatedSkillInputTokens int32

usedSkills boolean

includedVision boolean

attachedVolatileKnowledges

object[]

nullable

Array [

id uuid

expirationDate date-timenullable

fileId uuidnullable

fileName stringnullable

fileSize int64nullable

downloadUrl stringnullable

]

executorTaskLogs

object[]

nullable

Array [

key stringnullable

description stringnullable

duration int64

success boolean

]

input

object[]

nullable

The input used in the message execution. Populated only when include=input.

Array [

key stringnullable

value nullable

]

skills

object[]

nullable

The skills executed for this message. Populated only when include=skills.

Array [

name stringnullable

tool stringnullable

input

object[]

nullable

Array [

key stringnullable

value nullable

]

output stringnullable

usage

object

promptTokens int32

completionTokens int32

totalTokens int32

success boolean

error stringnullable

iteration int32nullable

durationMs int64nullable

startDate date-time

]

knowledge

object[]

nullable

The knowledge retrieved for this message. Populated only when include=knowledge.

Array [

fileId stringnullable

fileName stringnullable

content stringnullable

relevance double

pageFrom int32

pageTo int32

position int32

totalTokenCount int32

]

citations

object[]

nullable

The citations associated with this message. Populated only when include=citations.

Array [

citationIndex int32

startIndex int32

endIndex int32

relevance double

source

object

nullable

oneOf

KnowledgeFile

fileName stringnullable

knowledgeFileVersionId uuid

sectionId stringnullable

pageRange stringnullable

KnowledgeWebsite

knowledgeFileVersionId uuid

sectionId stringnullable

website stringnullable

WebSearch

url stringnullable

title stringnullable

]

costs

object

prompt double

completion double

services double

total double

currency stringnullable

]

Example (from schema)

{
  "id": "string",
  "name": "string",
  "startDate": "2024-07-29T15:51:28.071Z",
  "endDate": "2024-07-29T15:51:28.071Z",
  "messagesJson": "string",
  "userIdentifier": "string",
  "conversationStarters": [
    "string"
  ],
  "useVision": true,
  "open": true,
  "messages": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sender": "string",
      "type": "string",
      "value": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "metaAnalysis": {},
      "tokenUsage": {
        "promptTokens": 0,
        "completionTokens": 0,
        "reasoningTokens": 0,
        "cacheWriteTokens": 0,
        "cacheReadTokens": 0,
        "calculatedSystemDefinitionTokens": 0,
        "calculatedKnowledgeTokens": 0,
        "calculatedVolatileKnowledgeTokens": 0,
        "calculatedUserMessageTokens": 0,
        "calculatedMessagesTokens": 0,
        "calculatedSkillInputTokens": 0,
        "usedSkills": true,
        "includedVision": true
      },
      "attachedVolatileKnowledges": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "expirationDate": "2024-07-29T15:51:28.071Z",
          "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "fileName": "string",
          "fileSize": 0,
          "downloadUrl": "string"
        }
      ],
      "executorTaskLogs": [
        {
          "key": "string",
          "description": "string",
          "duration": 0,
          "success": true
        }
      ],
      "input": [
        {
          "key": "string"
        }
      ],
      "skills": [
        {
          "name": "string",
          "tool": "string",
          "input": [
            {
              "key": "string"
            }
          ],
          "output": "string",
          "usage": {
            "promptTokens": 0,
            "completionTokens": 0,
            "totalTokens": 0
          },
          "success": true,
          "error": "string",
          "iteration": 0,
          "durationMs": 0,
          "startDate": "2024-07-29T15:51:28.071Z"
        }
      ],
      "knowledge": [
        {
          "fileId": "string",
          "fileName": "string",
          "content": "string",
          "relevance": 0,
          "pageFrom": 0,
          "pageTo": 0,
          "position": 0,
          "totalTokenCount": 0
        }
      ],
      "citations": [
        {
          "citationIndex": 0,
          "startIndex": 0,
          "endIndex": 0,
          "relevance": 0,
          "source": {}
        }
      ],
      "costs": {
        "prompt": 0,
        "completion": 0,
        "services": 0,
        "total": 0,
        "currency": "string"
      }
    }
  ]
}

401

The user is unauthorized or the session expired

403

The user does not have permission

404

The entity was not found

500

There was an unexpected error

Loading...