Get Context by ID

Javascript SDK (Beta)

import { CortiEnvironment, CortiClient } from "@corti/sdk";

const client = new CortiClient({
    environment: CortiEnvironment.Eu,
    auth: {
        clientId: "YOUR_CLIENT_ID",
        clientSecret: "YOUR_CLIENT_SECRET"
    },
    tenantName: "YOUR_TENANT_NAME"
});
await client.agents.getContext("12345678-90ab-cdef-gh12-34567890abc", "contextId");

{
  "id": "<string>",
  "items": [
    {
      "id": "<string>",
      "contextId": "<string>",
      "status": {
        "state": "submitted",
        "message": {
          "role": "user",
          "parts": [
            {
              "kind": "text",
              "text": "<string>",
              "metadata": {}
            }
          ],
          "messageId": "<string>",
          "kind": "message",
          "metadata": {},
          "extensions": [
            "<string>"
          ],
          "referenceTaskIds": [
            "<string>"
          ],
          "taskId": "<string>",
          "contextId": "<string>"
        },
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "kind": "task",
      "history": [
        {
          "role": "user",
          "parts": [
            {
              "kind": "text",
              "text": "<string>",
              "metadata": {}
            }
          ],
          "messageId": "<string>",
          "kind": "message",
          "metadata": {},
          "extensions": [
            "<string>"
          ],
          "referenceTaskIds": [
            "<string>"
          ],
          "taskId": "<string>",
          "contextId": "<string>"
        }
      ],
      "artifacts": [
        {
          "artifactId": "<string>",
          "parts": [
            {
              "kind": "text",
              "text": "<string>",
              "metadata": {}
            }
          ],
          "name": "<string>",
          "description": "<string>",
          "metadata": {},
          "extensions": [
            "<string>"
          ]
        }
      ],
      "metadata": {}
    }
  ]
}

GET

agents

{id}

contexts

{contextId}

Javascript SDK (Beta)

import { CortiEnvironment, CortiClient } from "@corti/sdk";

const client = new CortiClient({
    environment: CortiEnvironment.Eu,
    auth: {
        clientId: "YOUR_CLIENT_ID",
        clientSecret: "YOUR_CLIENT_SECRET"
    },
    tenantName: "YOUR_TENANT_NAME"
});
await client.agents.getContext("12345678-90ab-cdef-gh12-34567890abc", "contextId");

{
  "id": "<string>",
  "items": [
    {
      "id": "<string>",
      "contextId": "<string>",
      "status": {
        "state": "submitted",
        "message": {
          "role": "user",
          "parts": [
            {
              "kind": "text",
              "text": "<string>",
              "metadata": {}
            }
          ],
          "messageId": "<string>",
          "kind": "message",
          "metadata": {},
          "extensions": [
            "<string>"
          ],
          "referenceTaskIds": [
            "<string>"
          ],
          "taskId": "<string>",
          "contextId": "<string>"
        },
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "kind": "task",
      "history": [
        {
          "role": "user",
          "parts": [
            {
              "kind": "text",
              "text": "<string>",
              "metadata": {}
            }
          ],
          "messageId": "<string>",
          "kind": "message",
          "metadata": {},
          "extensions": [
            "<string>"
          ],
          "referenceTaskIds": [
            "<string>"
          ],
          "taskId": "<string>",
          "contextId": "<string>"
        }
      ],
      "artifacts": [
        {
          "artifactId": "<string>",
          "parts": [
            {
              "kind": "text",
              "text": "<string>",
              "metadata": {}
            }
          ],
          "name": "<string>",
          "description": "<string>",
          "metadata": {},
          "extensions": [
            "<string>"
          ]
        }
      ],
      "metadata": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Tenant-Name

string

required

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Example:

"copiloteu"

Path Parameters

string

required

The identifier of the agent associated with the context.

Example:

"12345678-90ab-cdef-gh12-34567890abc"

contextId

string

required

The identifier of the context (thread) to retrieve tasks for.

Query Parameters

limit

integer

default:100

The maximum number of tasks and messages to return. If not specified all history is returned.

offset

integer

The number of tasks and messages to skip before starting to collect the result set. Default is 0.

Response

Tasks retrieved successfully.

string

The context ID.

items

object[]

Option 1
Option 2

Show child attributes

items.id

string

required

Unique identifier for the task.

items.contextId

string

required

Identifier for the context (thread) in which the task is created.

items.status

object

required

Show child attributes

items.status.state

enum<string>

required

The current state of the task.

Available options:

submitted,

working,

input-required,

completed,

canceled,

failed,

rejected,

auth-required,

unknown

items.status.message

object

Additional message or details about the task status.

Show child attributes

items.status.message.role

enum<string>

required

The role of the message sender.

Available options:

user,

agent

items.status.message.parts

object[]

required

The content of the message.

Option 1
Option 2
Option 3

Show child attributes

items.status.message.parts.kind

enum<string>

required

The kind of the part, always "text".

Available options:

text

items.status.message.parts.text

string

required

The text content of the part.

items.status.message.parts.metadata

object

Additional metadata for the text part.

items.status.message.messageId

string

required

Unique identifier for the message.

items.status.message.kind

enum<string>

required

The kind of the object, always "message".

Available options:

message

items.status.message.metadata

object

Additional metadata for the message.

items.status.message.extensions

string[]

Extensions for the message.

items.status.message.referenceTaskIds

string[]

Task IDs that this message references for additional context.

items.status.message.taskId

string

Unique identifier for the task associated with the message.

items.status.message.contextId

string

Identifier for the context (thread) in which the message is sent.

items.status.timestamp

string<date-time>

The timestamp when this status was recorded.

items.kind

enum<string>

required

The kind of the object, always "task".

Available options:

task

items.history

object[]

The history of messages associated with the task.

Show child attributes

items.history.role

enum<string>

required

The role of the message sender.

Available options:

user,

agent

items.history.parts

object[]

required

The content of the message.

Option 1
Option 2
Option 3

Show child attributes

items.history.parts.kind

enum<string>

required

The kind of the part, always "text".

Available options:

text

items.history.parts.text

string

required

The text content of the part.

items.history.parts.metadata

object

Additional metadata for the text part.

items.history.messageId

string

required

Unique identifier for the message.

items.history.kind

enum<string>

required

The kind of the object, always "message".

Available options:

message

items.history.metadata

object

Additional metadata for the message.

items.history.extensions

string[]

Extensions for the message.

items.history.referenceTaskIds

string[]

Task IDs that this message references for additional context.

items.history.taskId

string

Unique identifier for the task associated with the message.

items.history.contextId

string

Identifier for the context (thread) in which the message is sent.

items.artifacts

object[]

The artifacts associated with the task.

Show child attributes

items.artifacts.artifactId

string

required

Unique identifier for the artifact.

items.artifacts.parts

object[]

required

The content of the artifact.

Option 1
Option 2
Option 3

Show child attributes

items.artifacts.parts.kind

enum<string>

required

The kind of the part, always "text".

Available options:

text

items.artifacts.parts.text

string

required

The text content of the part.

items.artifacts.parts.metadata

object

Additional metadata for the text part.

items.artifacts.name

string

Name of the artifact.

items.artifacts.description

string

Description of the artifact.

items.artifacts.metadata

object

Additional metadata for the artifact.

items.artifacts.extensions

string[]

Extensions for the artifact.

items.metadata

object

Additional metadata for the task.

Get Task by ID List Registry Experts

Web Socket APIs

REST APIs

Agentic APIs (beta)

Admin APIs

Authorizations

Headers

Path Parameters

Query Parameters

Response