---
title: "What this workspace has and what you may do here, with a usage line per item [read]"
method: GET
path: "/workspace-describe"
tags: ["workspace-describe"]
---

# What this workspace has and what you may do here, with a usage line per item \[read\]

`GET /workspace-describe`

## Request

- Base URL: `https://api.agentsky.dev/v1`
- URL: `https://api.agentsky.dev/v1/workspace-describe`
- Auth: HTTP bearer

Agents, company skills, routines with their triggers, installed connectors with their tools, hook rules (policies), policy rules such as spend caps (policy_rules), remaining budget, and the caller's role, credential and route groups, read live. A workspace identity may ask before it exchanges itself.

## Response `200`

OK

- object
  - `workspace` WorkspaceDescription, required: What the caller's workspace has and what the caller may do there, each item with a one-line usage example
    - `workspace` object, required
      - `id` string
      - `slug` string
      - `name` string
    - `you` object, required
      - `role` string, nullable
      - `scopes` string[]
      - `credential` string
      - `route_groups` string[], nullable
      - `example` string
    - `agents` object[], required
      - `id` string
      - `name` string
      - `display_name` string
      - `harness` string
      - `model` string
      - `example` string
    - `skills` object[], required
      - `id` string
      - `name` string
      - `attach_by_default` boolean
      - `example` string
    - `routines` object[], required
      - `id` string
      - `name` string
      - `status` 'active' | 'paused'
      - `schedule` string, nullable
      - `triggers` string[]
      - `example` string
    - `connectors` object[], required
      - `id` string
      - `kind` string
      - `name` string
      - `origin` string
      - `granted_roles` string[]
      - `granted` boolean, nullable
      - `tools` object[]
        - `name` string, required
        - `description` string, required
        - `example` string, nullable, required
      - `example` string
    - `policies` object[], required: The workspace's hook rules (/universes/{slug}/hooks)
      - `point` string
      - `action` string
      - `enabled` boolean
      - `match` object
    - `policy_rules` object[], required: The workspace's policy rules (/universes/{slug}/policies): spend caps, tool-call and call-count limits and capability rules, disabled ones included
      - `id` string, required
      - `name` string, required
      - `kind` 'TOOL_CALL' | 'SPEND_CAP' | 'CALL_COUNT' | 'CAPABILITY', required
      - `enabled` boolean, required
      - `config` object, required
      - `layer` 'workspace' | 'agent' | 'session', required
      - `position` integer, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `example` string
    - `budget` object, required
      - `credit_usd` number, nullable
      - `session_budget_usd` number, nullable
      - `session_spent_usd` number, nullable
    - `help` object, required
      - `example` string
      - `topics` string[]
    - `unavailable` string[], required: Sections that could not be read

## Other responses

- `default`: Error — { error: { code, message } }

## Changes

- **2026-11-02** `e5e8f0229a99`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/agentsky/apis/agentsky-developer-api/changes/workspace-describe/get.md)

---

[API](https://skmtc.dev/agentsky/apis/agentsky-developer-api.md) - [All operations](https://skmtc.dev/agentsky/apis/agentsky-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agentsky/apis/agentsky-developer-api/revisions/0d435187cd55?raw)