A workspace with counts of its scoped entities; a *_capped count is a FLOOR (at least N), never a total

GET

/v1/workspaces/{id}/summary

curl --request GET \
  --url https://example.com/v1/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/summary \
  --header 'Authorization: Bearer <token>'

• this engine

Returns a workspace with counts of its scoped entities (agents, sessions, resources, groups). Counts come from one contents read through the caller’s scope; a *_capped count is a floor (“at least N”), never a total.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

id

required

string format: uuid

Resource identifier (UUIDv7).

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Responses

200

OK

Media type application/json

object

agent_count

required

integer

agent_count_capped

required

The matching count is a FLOOR (at least N), never a total.

boolean

group_count

required

integer

group_count_capped

required

boolean

is_default

required

boolean

name

required

string

resource_count

required

integer

resource_count_capped

required

boolean

session_count

required

integer

session_count_capped

required

boolean

slug

required

string

workspace_id

required

string format: uuid

Example ^generated

{
  "agent_count": 1,
  "agent_count_capped": true,
  "group_count": 1,
  "group_count_capped": true,
  "is_default": true,
  "name": "example",
  "resource_count": 1,
  "resource_count_capped": true,
  "session_count": 1,
  "session_count_capped": true,
  "slug": "example",
  "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}