openapi: 3.1.0
info:
title: Agno API Reference A2A Sessions API
description: The all-in-one, private, secure agent platform that runs in your cloud.
version: 2.5.6
tags:
- name: Sessions
paths:
/sessions:
get:
tags:
- Sessions
summary: List Sessions
description: Retrieve paginated list of sessions with filtering and sorting options. Supports filtering by session type (agent, team, workflow), component, user, and name. Sessions represent conversation histories and execution contexts.
operationId: get_sessions
security:
- HTTPBearer: []
parameters:
- name: type
in: query
required: false
schema:
$ref: '#/components/schemas/SessionType'
description: Type of sessions to retrieve (agent, team, or workflow)
default: agent
description: Type of sessions to retrieve (agent, team, or workflow)
- name: component_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter sessions by component ID (agent/team/workflow ID)
title: Component Id
description: Filter sessions by component ID (agent/team/workflow ID)
- name: user_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter sessions by user ID
title: User Id
description: Filter sessions by user ID
- name: session_name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter sessions by name (partial match)
title: Session Name
description: Filter sessions by name (partial match)
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
minimum: 1
- type: 'null'
description: Number of sessions to return per page
default: 20
title: Limit
description: Number of sessions to return per page
- name: page
in: query
required: false
schema:
anyOf:
- type: integer
minimum: 0
- type: 'null'
description: Page number for pagination
default: 1
title: Page
description: Page number for pagination
- name: sort_by
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Field to sort sessions by
default: created_at
title: Sort By
description: Field to sort sessions by
- name: sort_order
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/SortOrder'
- type: 'null'
description: Sort order (asc or desc)
default: desc
title: Sort Order
description: Sort order (asc or desc)
- name: db_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Database ID to query sessions from
title: Db Id
description: Database ID to query sessions from
- name: table
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: The database table to use
title: Table
description: The database table to use
responses:
'200':
description: Sessions retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedResponse_SessionSchema_'
example:
session_example:
summary: Example session response
value:
data:
- session_id: 6f6cfbfd-9643-479a-ae47-b8f32eb4d710
session_name: What tools do you have?
session_state: {}
created_at: '2025-09-05T16:02:09Z'
updated_at: '2025-09-05T16:02:09Z'
'400':
description: Invalid session type or filter parameters
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthenticatedResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
'422':
description: Validation error in query parameters
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
post:
tags:
- Sessions
summary: Create New Session
description: Create a new empty session with optional configuration. Useful for pre-creating sessions with specific session_state, metadata, or other properties before running any agent/team/workflow interactions. The session can later be used by providing its session_id in run requests.
operationId: create_session
security:
- HTTPBearer: []
parameters:
- name: type
in: query
required: false
schema:
$ref: '#/components/schemas/SessionType'
description: Type of session to create (agent, team, or workflow)
default: agent
description: Type of session to create (agent, team, or workflow)
- name: db_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Database ID to create session in
title: Db Id
description: Database ID to create session in
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSessionRequest'
description: Session configuration data
default: {}
responses:
'201':
description: Session created successfully
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AgentSessionDetailSchema'
- $ref: '#/components/schemas/TeamSessionDetailSchema'
- $ref: '#/components/schemas/WorkflowSessionDetailSchema'
title: Response Create Session
examples:
agent_session_example:
summary: Example created agent session
value:
user_id: user-123
agent_session_id: new-session-id
session_id: new-session-id
session_name: New Session
session_state:
key: value
metadata:
key: value
agent_id: agent-1
created_at: '2025-10-21T12:00:00Z'
updated_at: '2025-10-21T12:00:00Z'
'400':
description: Invalid request parameters
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthenticatedResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'500':
description: Failed to create session
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
delete:
tags:
- Sessions
summary: Delete Multiple Sessions
description: Delete multiple sessions by their IDs in a single operation. This action cannot be undone and will permanently remove all specified sessions and their runs.
operationId: delete_sessions
security:
- HTTPBearer: []
parameters:
- name: user_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: User ID to scope deletion to
title: User Id
description: User ID to scope deletion to
- name: db_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Database ID to use for deletion
title: Db Id
description: Database ID to use for deletion
- name: table
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Table to use for deletion
title: Table
description: Table to use for deletion
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSessionRequest'
responses:
'204':
description: Sessions deleted successfully
'400':
description: Invalid request - session IDs and types length mismatch
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthenticatedResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'500':
description: Failed to delete sessions
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
/sessions/{session_id}:
get:
tags:
- Sessions
summary: Get Session by ID
description: Retrieve detailed information about a specific session including metadata, configuration, and run history. Response schema varies based on session type (agent, team, or workflow).
operationId: get_session_by_id
security:
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
description: Session ID to retrieve
title: Session Id
description: Session ID to retrieve
- name: type
in: query
required: false
schema:
$ref: '#/components/schemas/SessionType'
description: Session type (agent, team, or workflow)
default: agent
description: Session type (agent, team, or workflow)
- name: user_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: User ID to query session from
title: User Id
description: User ID to query session from
- name: db_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Database ID to query session from
title: Db Id
description: Database ID to query session from
- name: table
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Table to query session from
title: Table
description: Table to query session from
responses:
'200':
description: Session details retrieved successfully
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AgentSessionDetailSchema'
- $ref: '#/components/schemas/TeamSessionDetailSchema'
- $ref: '#/components/schemas/WorkflowSessionDetailSchema'
title: Response Get Session By Id
examples:
agent_session_example:
summary: Example agent session response
value:
user_id: '123'
agent_session_id: 6f6cfbfd-9643-479a-ae47-b8f32eb4d710
session_id: 6f6cfbfd-9643-479a-ae47-b8f32eb4d710
session_name: What tools do you have?
session_summary:
summary: The user and assistant engaged in a conversation about the tools the agent has available.
updated_at: '2025-09-05T18:02:12.269392'
session_state: {}
agent_id: basic-agent
total_tokens: 160
agent_data:
name: Basic Agent
agent_id: basic-agent
model:
provider: OpenAI
name: OpenAIChat
id: gpt-4o
metrics:
input_tokens: 134
output_tokens: 26
total_tokens: 160
audio_input_tokens: 0
audio_output_tokens: 0
audio_total_tokens: 0
cache_read_tokens: 0
cache_write_tokens: 0
reasoning_tokens: 0
chat_history:
- content: '
- Use markdown to format your answers.
- The current time is 2025-09-05 18:02:09.171627.
You have access to memories from previous interactions with the user that you can use:
- User really likes Digimon and Japan.
- User really likes Japan.
- User likes coffee.
Note: this information is from previous interactions and may be updated in this conversation. You should always prefer information from this conversation over the past memories.'
from_history: false
stop_after_tool_call: false
role: system
created_at: 1757088129
- content: What tools do you have?
from_history: false
stop_after_tool_call: false
role: user
created_at: 1757088129
- content: I don't have access to external tools or the internet. However, I can assist you with a wide range of topics by providing information, answering questions, and offering suggestions based on the knowledge I've been trained on. If there's anything specific you need help with, feel free to ask!
from_history: false
stop_after_tool_call: false
role: assistant
metrics:
input_tokens: 134
output_tokens: 26
total_tokens: 160
created_at: 1757088129
created_at: '2025-09-05T16:02:09Z'
updated_at: '2025-09-05T16:02:09Z'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthenticatedResponse'
'404':
description: Session not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
'422':
description: Invalid session type
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
delete:
tags:
- Sessions
summary: Delete Session
description: Permanently delete a specific session and all its associated runs. This action cannot be undone and will remove all conversation history.
operationId: delete_session
security:
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
description: Session ID to delete
title: Session Id
description: Session ID to delete
- name: user_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: User ID to scope deletion to
title: User Id
description: User ID to scope deletion to
- name: db_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Database ID to use for deletion
title: Db Id
description: Database ID to use for deletion
- name: table
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Table to use for deletion
title: Table
description: Table to use for deletion
responses:
'204':
description: Successful Response
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthenticatedResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'500':
description: Failed to delete session
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
patch:
tags:
- Sessions
summary: Update Session
description: Update session properties such as session_name, session_state, metadata, or summary. Use this endpoint to modify the session name, update state, add metadata, or update the session summary.
operationId: update_session
security:
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
description: Session ID to update
title: Session Id
description: Session ID to update
- name: type
in: query
required: false
schema:
$ref: '#/components/schemas/SessionType'
description: Session type (agent, team, or workflow)
default: agent
description: Session type (agent, team, or workflow)
- name: user_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: User ID
title: User Id
description: User ID
- name: db_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Database ID to use for update operation
title: Db Id
description: Database ID to use for update operation
- name: table
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Table to use for update operation
title: Table
description: Table to use for update operation
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSessionRequest'
description: Session update data
responses:
'200':
description: Session updated successfully
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AgentSessionDetailSchema'
- $ref: '#/components/schemas/TeamSessionDetailSchema'
- $ref: '#/components/schemas/WorkflowSessionDetailSchema'
title: Response Update Session
examples:
update_summary:
summary: Update session summary
value:
summary:
summary: The user discussed project planning with the agent.
updated_at: '2025-10-21T14:30:00Z'
update_metadata:
summary: Update session metadata
value:
metadata:
tags:
- planning
- project
priority: high
update_session_name:
summary: Update session name
value:
session_name: Updated Session Name
update_session_state:
summary: Update session state
value:
session_state:
step: completed
context: Project planning finished
progress: 100
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthenticatedResponse'
'404':
description: Session not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
'422':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'500':
description: Failed to update session
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
/sessions/{session_id}/runs:
get:
tags:
- Sessions
summary: Get Session Runs
description: Retrieve all runs (executions) for a specific session with optional timestamp filtering. Runs represent individual interactions or executions within a session. Response schema varies based on session type.
operationId: get_session_runs
security:
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
description: Session ID to get runs from
title: Session Id
description: Session ID to get runs from
- name: type
in: query
required: false
schema:
$ref: '#/components/schemas/SessionType'
description: Session type (agent, team, or workflow)
default: agent
description: Session type (agent, team, or workflow)
- name: user_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: User ID to query runs from
title: User Id
description: User ID to query runs from
- name: created_after
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Filter runs created after this Unix timestamp (epoch time in seconds)
title: Created After
description: Filter runs created after this Unix timestamp (epoch time in seconds)
- name: created_before
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Filter runs created before this Unix timestamp (epoch time in seconds)
title: Created Before
description: Filter runs created before this Unix timestamp (epoch time in seconds)
- name: db_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Database ID to query runs from
title: Db Id
description: Database ID to query runs from
- name: table
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Table to query runs from
title: Table
description: Table to query runs from
responses:
'200':
description: Session runs retrieved successfully
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/RunSchema'
- $ref: '#/components/schemas/TeamRunSchema'
- $ref: '#/components/schemas/WorkflowRunSchema'
title: Response Get Session Runs
examples:
completed_run:
summary: Example completed run
value:
run_id: fcdf50f0-7c32-4593-b2ef-68a558774340
parent_run_id: 80056af0-c7a5-4d69-b6a2-c3eba9f040e0
agent_id: basic-agent
user_id: ''
run_input: Which tools do you have access to?
content: I don't have access to external tools or the internet. However, I can assist you with a wide range of topics by providing information, answering questions, and offering suggestions based on the knowledge I've been trained on. If there's anything specific you need help with, feel free to ask!
run_response_format: text
reasoning_content: ''
metrics:
input_tokens: 82
output_tokens: 56
total_tokens: 138
time_to_first_token: 0.047505500027909875
duration: 4.840060166025069
messages:
- content: '
- Use markdown to format your answers.
- The current time is 2025-09-08 17:52:10.101003.
You have the capability to retain memories from previous interactions with the user, but have not had any interactions with the user yet.'
from_history: false
stop_after_tool_call: false
role: system
created_at: 1757346730
- content: Which tools do you have access to?
from_history: false
stop_after_tool_call: false
role: user
created_at: 1757346730
- content: I don't have access to external tools or the internet. However, I can assist you with a wide range of topics by providing information, answering questions, and offering suggestions based on the knowledge I've been trained on. If there's anything specific you need help with, feel free to ask!
from_history: false
stop_after_tool_call: false
role: assistant
metrics:
input_tokens: 82
output_tokens: 56
total_tokens: 138
created_at: 1757346730
events:
- created_at: 1757346730
event: RunStarted
agent_id: basic-agent
agent_name: Basic Agent
run_id: fcdf50f0-7c32-4593-b2ef-68a558774340
session_id: 80056af0-c7a5-4d69-b6a2-c3eba9f040e0
model: gpt-4o
model_provider: OpenAI
- created_at: 1757346733
event: MemoryUpdateStarted
agent_id: basic-agent
agent_name: Basic Agent
run_id: fcdf50f0-7c32-4593-b2ef-68a558774340
session_id: 80056af0-c7a5-4d69-b6a2-c3eba9f040e0
- created_at: 1757346734
event: MemoryUpdateCompleted
agent_id: basic-agent
agent_name: Basic Agent
run_id: fcdf50f0-7c32-4593-b2ef-68a558774340
session_id: 80056af0-c7a5-4d69-b6a2-c3eba9f040e0
- created_at: 1757346734
event: RunCompleted
agent_id: basic-agent
agent_name: Basic Agent
run_id: fcdf50f0-7c32-4593-b2ef-68a558774340
session_id: 80056af0-c7a5-4d69-b6a2-c3eba9f040e0
content: I don't have access to external tools or the internet. However, I can assist you with a wide range of topics by providing information, answering questions, and offering suggestions based on the knowledge I've been trained on. If there's anything specific you need help with, feel free to ask!
content_type: str
metrics:
input_tokens: 82
output_tokens: 56
total_tokens: 138
time_to_first_token: 0.047505500027909875
duration: 4.840060166025069
created_at: '2025-09-08T15:52:10Z'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthenticatedResponse'
'404':
description: Session not found or has no runs
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
'422':
description: Invalid session type
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
/sessions/{session_id}/runs/{run_id}:
get:
tags:
- Sessions
summary: Get Run by ID
description: Retrieve a specific run by its ID from a session. Response schema varies based on the run type (agent run, team run, or workflow run).
operationId: get_session_run
security:
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
description: Session ID to get run from
title: Session Id
description: Session ID to get run from
- name: run_id
in: path
required: true
schema:
type: string
description: Run ID to retrieve
title: Run Id
description: Run ID to retrieve
- name: type
in: query
required: false
schema:
$ref: '#/components/schemas/SessionType'
description: Session type (agent, team, or workflow)
default: agent
description: Session type (agent, team, or workflow)
- name: user_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: User ID to query run from
title: User Id
description: User ID to query run from
- name: db_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Database ID to query run from
title: Db Id
description: Database ID to query run from
- name: table
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Table to query run from
title: Table
description: Table to query run from
responses:
'200':
description: Run retrieved successfully
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/RunSchema'
- $ref: '#/components/schemas/TeamRunSchema'
- $ref: '#/components/schemas/WorkflowRunSchema'
title: Response Get Session Run
examples:
agent_run:
summary: Example agent run
value:
run_id: fcdf50f0-7c32-4593-b2ef-68a558774340
parent_run_id: 80056af0-c7a5-4d69-b6a2-c3eba9f040e0
agent_id: basic-agent
user_id: user_123
run_input: Which tools do you have access to?
content: I don't have access to external tools.
created_at: 1728499200
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthenticatedResponse'
'404':
description: Session or run not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
'422':
description: Invalid session type
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
/sessions/{session_id}/rename:
post:
tags:
- Sessions
summary: Rename Session
description: Update the name of an existing session. Useful for organizing and categorizing sessions with meaningful names for better identification and management.
operationId: rename_session
security:
- HTTPBearer: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
description: Session ID to rename
title: Session Id
description: Session ID to rename
- name: type
in: query
required: false
schema:
$ref: '#/components/schemas/SessionType'
description: Session type (agent, team, or workflow)
default: agent
description: Session type (agent, team, or workflow)
- name: user_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: User ID to scope rename to
title: User Id
description: User ID to scope rename to
- name: db_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Database ID to use for rename operation
title: Db Id
description: Database ID to use for rename operation
- name: table
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Table to use for rename operation
title: Table
description: Table to use for rename operation
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_rename_session'
responses:
'200':
description: Session renamed successfully
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AgentSessionDetailSchema'
- $ref: '#/components/schemas/TeamSessionDetailSchema'
- $ref: '#/components/schemas/WorkflowSessionDetailSchema'
title: Response Rename Session
examples:
agent_session_example:
summary: Example agent session response
value:
user_id: '123'
agent_session_id: 6f6cfbfd-9643-479a-ae47-b8f32eb4d710
session_id: 6f6cfbfd-9643-479a-ae47-b8f32eb4d710
session_name: What tools do you have?
session_summary:
summary: The user and assistant engaged in a conversation about the tools the agent has available.
updated_at: '2025-09-05T18:02:12.269392'
session_state: {}
agent_id: basic-agent
total_tokens: 160
agent_data:
name: Basic Agent
agent_id: basic-agent
model:
provider: OpenAI
name: OpenAIChat
id: gpt-4o
metrics:
input_tokens: 134
output_tokens: 26
total_tokens: 160
audio_input_tokens: 0
audio_output_tokens: 0
audio_total_tokens: 0
cache_read_tokens: 0
cache_write_tokens: 0
reasoning_tokens: 0
chat_history:
- content: '
- Use markdown to format your answers.
- The current time is 2025-09-05 18:02:09.171627.
You have access to memories from previous interactions with the user that you can use:
- User really likes Digimon and Japan.
- User really likes Japan.
- User likes coffee.
Note: this information is from previous interactions and may be updated in this conversation. You should always prefer information from this conversation over the past memories.'
from_history: false
stop_after_tool_call: false
role: system
created_at: 1757088129
- content: What tools do you have?
from_history: false
stop_after_tool_call: false
role: user
created_at: 1757088129
- content: I don't have access to external tools or the internet. However, I can assist you with a wide range of topics by providing information, answering questions, and offering suggestions based on the knowledge I've been trained on. If there's anything specific you need help with, feel free to ask!
from_history: false
stop_after_tool_call: false
role: assistant
metrics:
input_tokens: 134
output_tokens: 26
total_tokens: 160
created_at: 1757088129
created_at: '2025-09-05T16:02:09Z'
updated_at: '2025-09-05T16:02:09Z'
'400':
description: Invalid session name
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthenticatedResponse'
'404':
description: Session not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
'422':
description: Invalid session type or validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
components:
schemas:
InternalServerErrorResponse:
properties:
detail:
type: string
title: Detail
description: Error detail message
error_code:
anyOf:
- type: string
- type: 'null'
title: Error Code
description: Error code for categorization
type: object
required:
- detail
title: InternalServerErrorResponse
example:
detail: Internal server error
error_code: INTERNAL_SERVER_ERROR
UnauthenticatedResponse:
properties:
detail:
type: string
title: Detail
description: Error detail message
error_code:
anyOf:
- type: string
- type: 'null'
title: Error Code
description: Error code for categorization
type: object
required:
- detail
title: UnauthenticatedResponse
example:
detail: Unauthenticated access
error_code: UNAUTHENTICATED
CreateSessionRequest:
properties:
session_id:
anyOf:
- type: string
- type: 'null'
title: Session Id
description: Optional session ID (generated if not provided)
session_name:
anyOf:
- type: string
- type: 'null'
title: Session Name
description: Name for the session
session_state:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Session State
description: Initial session state
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
description: Additional metadata
user_id:
anyOf:
- type: string
- type: 'null'
title: User Id
description: User ID associated with the session
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
description: Agent ID if this is an agent session
team_id:
anyOf:
- type: string
- type: 'null'
title: Team Id
description: Team ID if this is a team session
workflow_id:
anyOf:
- type: string
- type: 'null'
title: Workflow Id
description: Workflow ID if this is a workflow session
type: object
title: CreateSessionRequest
Body_rename_session:
properties:
session_name:
type: string
title: Session Name
description: New name for the session
type: object
required:
- session_name
title: Body_rename_session
NotFoundResponse:
properties:
detail:
type: string
title: Detail
description: Error detail message
error_code:
anyOf:
- type: string
- type: 'null'
title: Error Code
description: Error code for categorization
type: object
required:
- detail
title: NotFoundResponse
example:
detail: Not found
error_code: NOT_FOUND
WorkflowRunSchema:
properties:
run_id:
type: string
title: Run Id
description: Unique identifier for the workflow run
run_input:
anyOf:
- type: string
- type: 'null'
title: Run Input
description: Input provided to the workflow
events:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Events
description: Events generated during the workflow
workflow_id:
anyOf:
- type: string
- type: 'null'
title: Workflow Id
description: Workflow ID that was executed
user_id:
anyOf:
- type: string
- type: 'null'
title: User Id
description: User ID associated with the run
content:
anyOf:
- type: string
- additionalProperties: true
type: object
- type: 'null'
title: Content
description: Output content from the workflow
content_type:
anyOf:
- type: string
- type: 'null'
title: Content Type
description: Type of content returned
status:
anyOf:
- type: string
- type: 'null'
title: Status
description: Status of the workflow run
step_results:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Step Results
description: Results from each workflow step
step_executor_runs:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Step Executor Runs
description: Executor runs for each step
metrics:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metrics
description: Performance and usage metrics
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Run creation timestamp
reasoning_content:
anyOf:
- type: string
- type: 'null'
title: Reasoning Content
description: Reasoning content if reasoning was enabled
reasoning_steps:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Reasoning Steps
description: List of reasoning steps
references:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: References
description: References cited in the workflow
citations:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Citations
description: Citations from the model (e.g., from Gemini grounding/search)
reasoning_messages:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Reasoning Messages
description: Reasoning process messages
images:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Images
description: Images included in the workflow
videos:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Videos
description: Videos included in the workflow
audio:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Audio
description: Audio files included in the workflow
files:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Files
description: Files included in the workflow
response_audio:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Response Audio
description: Audio response if generated
type: object
required:
- run_id
title: WorkflowRunSchema
SessionSchema:
properties:
session_id:
type: string
title: Session Id
description: Unique identifier for the session
session_name:
type: string
title: Session Name
description: Human-readable name for the session
session_state:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Session State
description: Current state data of the session
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Timestamp when session was created
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Timestamp when session was last updated
type: object
required:
- session_id
- session_name
title: SessionSchema
UpdateSessionRequest:
properties:
session_name:
anyOf:
- type: string
- type: 'null'
title: Session Name
description: Updated session name
session_state:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Session State
description: Updated session state
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
description: Updated metadata
summary:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Summary
description: Session summary
type: object
title: UpdateSessionRequest
BadRequestResponse:
properties:
detail:
type: string
title: Detail
description: Error detail message
error_code:
anyOf:
- type: string
- type: 'null'
title: Error Code
description: Error code for categorization
type: object
required:
- detail
title: BadRequestResponse
example:
detail: Bad request
error_code: BAD_REQUEST
WorkflowSessionDetailSchema:
properties:
user_id:
anyOf:
- type: string
- type: 'null'
title: User Id
description: User ID associated with the session
workflow_id:
anyOf:
- type: string
- type: 'null'
title: Workflow Id
description: Workflow ID used in this session
workflow_name:
anyOf:
- type: string
- type: 'null'
title: Workflow Name
description: Name of the workflow
session_id:
type: string
title: Session Id
description: Unique session identifier
session_name:
type: string
title: Session Name
description: Human-readable session name
session_data:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Session Data
description: Complete session data
session_state:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Session State
description: Current workflow state
workflow_data:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Workflow Data
description: Workflow-specific data
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
description: Additional metadata
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Session creation timestamp
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Last update timestamp
type: object
required:
- session_id
- session_name
title: WorkflowSessionDetailSchema
SessionType:
type: string
enum:
- agent
- team
- workflow
title: SessionType
ValidationErrorResponse:
properties:
detail:
type: string
title: Detail
description: Error detail message
error_code:
anyOf:
- type: string
- type: 'null'
title: Error Code
description: Error code for categorization
type: object
required:
- detail
title: ValidationErrorResponse
example:
detail: Validation error
error_code: VALIDATION_ERROR
PaginationInfo:
properties:
page:
type: integer
minimum: 0
title: Page
description: Current page number (0-indexed)
default: 0
limit:
type: integer
minimum: 1
title: Limit
description: Number of items per page
default: 20
total_pages:
type: integer
minimum: 0
title: Total Pages
description: Total number of pages
default: 0
total_count:
type: integer
minimum: 0
title: Total Count
description: Total count of items
default: 0
search_time_ms:
type: number
minimum: 0
title: Search Time Ms
description: Search execution time in milliseconds
default: 0
type: object
title: PaginationInfo
RunSchema:
properties:
run_id:
type: string
title: Run Id
description: Unique identifier for the run
parent_run_id:
anyOf:
- type: string
- type: 'null'
title: Parent Run Id
description: Parent run ID if this is a nested run
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
description: Agent ID that executed this run
user_id:
anyOf:
- type: string
- type: 'null'
title: User Id
description: User ID associated with the run
status:
anyOf:
- type: string
- type: 'null'
title: Status
description: Run status (PENDING, RUNNING, COMPLETED, ERROR, etc.)
run_input:
anyOf:
- type: string
- type: 'null'
title: Run Input
description: Input provided to the run
content:
anyOf:
- type: string
- additionalProperties: true
type: object
- type: 'null'
title: Content
description: Output content from the run
run_response_format:
anyOf:
- type: string
- type: 'null'
title: Run Response Format
description: Format of the response (text/json)
reasoning_content:
anyOf:
- type: string
- type: 'null'
title: Reasoning Content
description: Reasoning content if reasoning was enabled
reasoning_steps:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Reasoning Steps
description: List of reasoning steps
metrics:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metrics
description: Performance and usage metrics
messages:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Messages
description: Message history for the run
tools:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Tools
description: Tools used in the run
events:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Events
description: Events generated during the run
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Run creation timestamp
references:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: References
description: References cited in the run
citations:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Citations
description: Citations from the model (e.g., from Gemini grounding/search)
reasoning_messages:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Reasoning Messages
description: Reasoning process messages
session_state:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Session State
description: Session state at the end of the run
images:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Images
description: Images included in the run
videos:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Videos
description: Videos included in the run
audio:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Audio
description: Audio files included in the run
files:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Files
description: Files included in the run
response_audio:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Response Audio
description: Audio response if generated
input_media:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Input Media
description: Input media attachments
type: object
required:
- run_id
title: RunSchema
DeleteSessionRequest:
properties:
session_ids:
items:
type: string
type: array
minItems: 1
title: Session Ids
description: List of session IDs to delete
session_types:
items:
$ref: '#/components/schemas/SessionType'
type: array
minItems: 1
title: Session Types
description: Types of sessions to delete
type: object
required:
- session_ids
- session_types
title: DeleteSessionRequest
PaginatedResponse_SessionSchema_:
properties:
data:
items:
$ref: '#/components/schemas/SessionSchema'
type: array
title: Data
description: List of items for the current page
meta:
$ref: '#/components/schemas/PaginationInfo'
description: Pagination metadata
type: object
required:
- data
- meta
title: PaginatedResponse[SessionSchema]
SortOrder:
type: string
enum:
- asc
- desc
title: SortOrder
AgentSessionDetailSchema:
properties:
user_id:
anyOf:
- type: string
- type: 'null'
title: User Id
description: User ID associated with the session
agent_session_id:
type: string
title: Agent Session Id
description: Unique agent session identifier
session_id:
type: string
title: Session Id
description: Session identifier
session_name:
type: string
title: Session Name
description: Human-readable session name
session_summary:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Session Summary
description: Summary of session interactions
session_state:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Session State
description: Current state of the session
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
description: Agent ID used in this session
total_tokens:
anyOf:
- type: integer
- type: 'null'
title: Total Tokens
description: Total tokens used in this session
agent_data:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Agent Data
description: Agent-specific data
metrics:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metrics
description: Session metrics
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
description: Additional metadata
chat_history:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Chat History
description: Complete chat history
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Session creation timestamp
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Last update timestamp
type: object
required:
- agent_session_id
- session_id
- session_name
title: AgentSessionDetailSchema
TeamRunSchema:
properties:
run_id:
type: string
title: Run Id
description: Unique identifier for the team run
parent_run_id:
anyOf:
- type: string
- type: 'null'
title: Parent Run Id
description: Parent run ID if this is a nested run
team_id:
anyOf:
- type: string
- type: 'null'
title: Team Id
description: Team ID that executed this run
status:
anyOf:
- type: string
- type: 'null'
title: Status
description: Run status (PENDING, RUNNING, COMPLETED, ERROR, etc.)
content:
anyOf:
- type: string
- additionalProperties: true
type: object
- type: 'null'
title: Content
description: Output content from the team run
reasoning_content:
anyOf:
- type: string
- type: 'null'
title: Reasoning Content
description: Reasoning content if reasoning was enabled
reasoning_steps:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Reasoning Steps
description: List of reasoning steps
run_input:
anyOf:
- type: string
- type: 'null'
title: Run Input
description: Input provided to the run
run_response_format:
anyOf:
- type: string
- type: 'null'
title: Run Response Format
description: Format of the response (text/json)
metrics:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metrics
description: Performance and usage metrics
tools:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Tools
description: Tools used in the run
messages:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Messages
description: Message history for the run
events:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Events
description: Events generated during the run
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Run creation timestamp
references:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: References
description: References cited in the run
citations:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Citations
description: Citations from the model (e.g., from Gemini grounding/search)
reasoning_messages:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Reasoning Messages
description: Reasoning process messages
session_state:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Session State
description: Session state at the end of the run
input_media:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Input Media
description: Input media attachments
images:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Images
description: Images included in the run
videos:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Videos
description: Videos included in the run
audio:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Audio
description: Audio files included in the run
files:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Files
description: Files included in the run
response_audio:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Response Audio
description: Audio response if generated
type: object
required:
- run_id
title: TeamRunSchema
TeamSessionDetailSchema:
properties:
session_id:
type: string
title: Session Id
description: Unique session identifier
session_name:
type: string
title: Session Name
description: Human-readable session name
user_id:
anyOf:
- type: string
- type: 'null'
title: User Id
description: User ID associated with the session
team_id:
anyOf:
- type: string
- type: 'null'
title: Team Id
description: Team ID used in this session
session_summary:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Session Summary
description: Summary of team interactions
session_state:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Session State
description: Current state of the session
metrics:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metrics
description: Session metrics
team_data:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Team Data
description: Team-specific data
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
description: Additional metadata
chat_history:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
title: Chat History
description: Complete chat history
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Session creation timestamp
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Last update timestamp
total_tokens:
anyOf:
- type: integer
- type: 'null'
title: Total Tokens
description: Total tokens used in this session
type: object
required:
- session_id
- session_name
title: TeamSessionDetailSchema
securitySchemes:
HTTPBearer:
type: http
scheme: bearer