Skip to main content
PATCH
Update Session

Authentication

Requires an API key.

Path parameters

string
required
The ID of the session to update.

Query parameters

string
The ID of the workspace the session belongs to. Optional when using an API key.

Request body

All fields are optional — only include the fields you want to update.
string
New title for the session.
string
New status. One of active, completed, or failed.

Response

object
The updated session object. See List Sessions for the full schema.

Example

Response

Errors