List agent sessions

import requests

url = "https://app.ubik-agent.com/api/v1/agent-sessions"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://app.ubik-agent.com/api/v1/agent-sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "model_name": "<string>",
      "external_user_id": "<string>",
      "active_tools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "active_skills": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "documents": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "status": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "file_type": "<string>",
          "processing_pipeline": "<string>",
          "error_message": "<string>",
          "api_metadata": {},
          "is_starred": false
        }
      ],
      "workspaces": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "document_count": 123,
          "description": "<string>",
          "is_default": false,
          "workspace_metadata": {}
        }
      ],
      "mcp_config": {}
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "has_more": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

agent-sessions

List agent sessions

import requests

url = "https://app.ubik-agent.com/api/v1/agent-sessions"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://app.ubik-agent.com/api/v1/agent-sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "model_name": "<string>",
      "external_user_id": "<string>",
      "active_tools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "active_skills": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "documents": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "status": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "file_type": "<string>",
          "processing_pipeline": "<string>",
          "error_message": "<string>",
          "api_metadata": {},
          "is_starred": false
        }
      ],
      "workspaces": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "document_count": 123,
          "description": "<string>",
          "is_default": false,
          "workspace_metadata": {}
        }
      ],
      "mcp_config": {}
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "has_more": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Headers

X-End-User-ID

string | null

Query Parameters

page

integer

default:1

Required range: x >= 1

limit

integer

default:20

Required range: 1 <= x <= 100

Response

Successful Response

items

PublicAgentSession · object[]

required

Hide child attributes

items.id

string<uuid>

required

Unique identifier for the session.

items.status

string

required

Current status (e.g., 'active', 'completed').

items.created_at

string<date-time>

required

Creation timestamp.

items.updated_at

string<date-time>

required

Last update timestamp.

items.title

string | null

Title of the session.

items.model_name

string | null

Model being used.

items.external_user_id

string | null

The external user ID associated with this session, if any.

items.active_tools

PublicToolListItem · object[]

List of tools enabled for this session.

Hide child attributes

items.active_tools.id

string<uuid>

required

The unique identifier for the tool.

items.active_tools.name

string

required

The name of the tool.

items.active_tools.description

string | null

A brief description of what the tool does.

items.active_skills

PublicSkillListItem · object[]

List of skills enabled for this session.

Hide child attributes

items.active_skills.id

string<uuid>

required

The unique identifier for the skill.

items.active_skills.name

string

required

The name of the skill.

items.active_skills.description

string | null

A brief description of what the skill does.

items.documents

PublicSessionDocumentListItem · object[]

List of documents linked to this session.

Hide child attributes

items.documents.id

string<uuid>

required

The unique identifier for the document.

items.documents.name

string

required

The display name of the document.

items.documents.status

string

required

The current processing status of the document.

items.documents.created_at

string<date-time>

required

The timestamp when the document was created.

items.documents.updated_at

string<date-time>

required

The timestamp when the document was last updated.

items.documents.file_type

string | null

The MIME type of the document file.

items.documents.processing_pipeline

string | null

The name of the processing pipeline used for this document.

items.documents.error_message

string | null

If processing failed, this field will contain the error message.

items.documents.api_metadata

Api Metadata · object | null

Custom API metadata resolved for the current user. Useful for retrieving stored external references (e.g. {'internal_app_ref': 'REF-123'}). Note: This value is resolved based on the request's external_user_id. A document shared globally but also scoped to a specific user may return different metadata depending on who is asking.

items.documents.is_starred

boolean

default:false

Whether the document is starred in the current session context.

items.workspaces

PublicWorkspace · object[]

List of workspaces linked to this session.

Hide child attributes

items.workspaces.id

string<uuid>

required

The unique identifier for the workspace.

items.workspaces.name

string

required

The name of the workspace.

items.workspaces.created_at

string<date-time>

required

The timestamp when the workspace was created.

items.workspaces.updated_at

string<date-time>

required

The timestamp when the workspace was last updated.

items.workspaces.document_count

integer

required

The number of documents contained within the workspace.

items.workspaces.description

string | null

A brief description of the workspace's purpose.

items.workspaces.is_default

boolean | null

default:false

Indicates if this is the default workspace for the user.

items.workspaces.workspace_metadata

Workspace Metadata · object | null

Metadata for the workspace.

items.mcp_config

Mcp Config · object | null

The currently active MCP configuration for this session.

total

integer

required

page

integer

required

limit

integer

required

has_more

boolean

required