For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • POSTGet costs summary
        • GETGet workspace configuration
        • PUTUpsert workspace configuration
        • DELDelete workspace configuration
        • POSTGet cost daily data
        • POSTGet metric daily data
        • GETGet workspace version
        • POSTGet metrics summary
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceWorkspaces

Upsert workspace configuration

PUT
/v1/private/workspaces/configurations
PUT
/api/v1/private/workspaces/configurations
$curl -X PUT http://localhost:5173/api/v1/private/workspaces/configurations \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "timeout_to_mark_thread_as_inactive": "string",
3 "truncation_on_tables": true,
4 "color_map": {}
5}
Upsert workspace configuration
Was this page helpful?
Previous

Delete workspace configuration

Next
Built with

Request

This endpoint expects an object.
timeout_to_mark_thread_as_inactivestringOptional

Duration in ISO-8601 format (e.g., PT30M for 30 minutes, PT2H for 2 hours, P1D for 1 day). Minimum precision supported is seconds, please use a duration with seconds precision or higher. Also, the max duration allowed is 7 days.

truncation_on_tablesbooleanOptional

Enable or disable data truncation in table views. When disabled, the frontend will limit pagination to prevent performance issues. Default: true (truncation enabled).

color_mapmap from strings to stringsOptional

Workspace-level color map. Maps label names to hex color values (e.g. #FF0000). Max 10000 entries.

Response

Configuration Updated
timeout_to_mark_thread_as_inactivestring

Duration in ISO-8601 format (e.g., PT30M for 30 minutes, PT2H for 2 hours, P1D for 1 day). Minimum precision supported is seconds, please use a duration with seconds precision or higher. Also, the max duration allowed is 7 days.

truncation_on_tablesboolean

Enable or disable data truncation in table views. When disabled, the frontend will limit pagination to prevent performance issues. Default: true (truncation enabled).

color_mapmap from strings to strings

Workspace-level color map. Maps label names to hex color values (e.g. #FF0000). Max 10000 entries.

Errors

400
Bad Request Error
422
Unprocessable Entity Error