Sign in

v1

latestOpenAPI 3.1.02026-07-17204239.3 KB

Update

Update Session based of the input PublicSession.

Security note: this function updates only very specific and security-irrelevant fields.

post/v1/session/update

Request body

idstring

Session unique ramdom identifier.

user_idstring required

The user ID this session belongs to.

org_idstring required

The organization ID this session belongs to.

ttlinteger required

The time to live of the session in seconds.

languagestring

The iso-code of the session language.

turnsinteger

The number of turns in the session.

namestring required

Human readable session name.

descriptionstring required

A brief description to help users remember what the session is about.

create_timenumber

The Unix timestamp of when the session was created.

update_timenumber

The Unix timestamp of when the session was last updated.

num_messagesinteger

The number of messages in the session.

can_logboolean

Whether the session can be logged or not.

state'undefined' | 'start' | 'end' | 'query' | 'running_agent' | 'agent_done' | 'coding' | 'code_result' | 'calling_tool' | 'tool_result' | 'generating' | 'answering' | 'thinking' | 'planning' | 'reviewing' | 'understanding' | 'retrieving' | 'grounding'

Response

Successful Response

okboolean required

True if the operation was successful.

status_code200 | 201 | 202 | 204 | 206 | 300 | 301 | 302 | 303 | 304 | 307 | 308 | 400 | 401 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 422 | 425 | 426 | 428 | 429 | 429 | 431 | 451 | 500 | 500 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511 required
status_messagestring

Describe why the operation failed.

dataobject nullable

Optional field for additional information.

mime_type'text/plain' | 'text/markdown' | 'text/serialized-json' | 'application/octet-stream' | 'image/jpeg' | 'image/png' | 'image/tiff' | 'image/gif' | 'image/svg+xml' | 'image/webp' | 'image/avif' | 'audio/wav' | 'audio/mpeg' | 'audio/ogg' | 'video/webm' | 'video/mp4' | 'text/c' | 'text/c++' | 'text/java' | 'text/rust' | 'text/go' | 'text/python' | 'text/php' | 'text/perl' | 'text/ruby' | 'text/swift' | 'text/kotlin' | 'text/scala' | 'text/javascript' | 'text/typescript' | 'text/html' | 'text/css' | 'text/csv' | 'text/xml' | 'text/yaml' | 'text/toml' | 'text/sql' | 'application/json' | 'application/jsonl' | 'application/pdf' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'application/vnd.openxmlformats-officedocument.presentationml.presentation' | 'application/msword' | 'application/vnd.ms-excel' | 'application/vnd.ms-powerpoint' | 'application/rtf' | 'application/vnd.oasis.opendocument.text' | 'sec-gemini/graph' | 'sec-gemini/timeline' | 'sec-gemini/table' | 'sec-gemini/image' | 'sec-gemini/code' | 'sec-gemini/markdown' | 'sec-gemini/json' | 'sec-gemini/html' | 'sec-gemini/canvas'

Completion type

latencynumber nullable

The time taken to complete the request in seconds.