Skip to main content
GET
/
workspaces
/
{workspace_id}
Get workspace details
import requests

url = "https://app.ubik-agent.com/api/v1/workspaces/{workspace_id}"

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

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

print(response.text)
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "My Project Workspace",
  "description": "Contains all documents related to the Q1 sales report.",
  "is_default": true,
  "created_at": "2025-09-28T10:00:00Z",
  "updated_at": "2025-09-28T11:00:00Z",
  "document_count": 42
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
workspace_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required

The unique identifier for the workspace.

​
name
string
required

The name of the workspace.

​
created_at
string<date-time>
required

The timestamp when the workspace was created.

​
updated_at
string<date-time>
required

The timestamp when the workspace was last updated.

​
document_count
integer
required

The number of documents contained within the workspace.

​
description
string | null

A brief description of the workspace's purpose.

​
is_default
boolean | null
default:false

Indicates if this is the default workspace for the user.