Skip to content
Agent HQ

Workspaces API

List workspaces

Section titled “List workspaces”
GET /api/workspaces

Returns workspaces the authenticated user belongs to.

Response 200 OK

[
  {
    "id": "ws_abc123",
    "name": "My Workspace",
    "role": "owner",
    "created_at": "2025-01-01T00:00:00Z"
  }
]

Create workspace

Section titled “Create workspace”
POST /api/workspaces

Request body

{
  "name": "My Team Workspace"
}

Get workspace

Section titled “Get workspace”
GET /api/workspaces/{id}

Update workspace

Section titled “Update workspace”
PUT /api/workspaces/{id}

Request body

{
  "name": "Renamed Workspace",
  "autonomous_enabled": true,
  "weekly_budget_cents": 10000
}

Delete workspace

Section titled “Delete workspace”
DELETE /api/workspaces/{id}

Members

Section titled “Members”

List members

Section titled “List members”
GET /api/workspaces/{id}/members

Response 200 OK

[
  {
    "id": "mem_1",
    "user_id": "user_abc",
    "role": "owner",
    "user": {
      "name": "Alice",
      "email": "alice@example.com",
      "avatar_url": "https://..."
    }
  }
]

Remove member

Section titled “Remove member”
DELETE /api/workspaces/{id}/members

Invitations

Section titled “Invitations”

List invitations

Section titled “List invitations”
GET /api/workspaces/{id}/invitations

Create invitation

Section titled “Create invitation”
POST /api/workspaces/{id}/invitations

Request body

{
  "email": "bob@example.com",
  "role": "member"
}

Get invitation

Section titled “Get invitation”
GET /api/invitations/{id}

Accept invitation

Section titled “Accept invitation”
POST /api/invitations/{id}

Accepts the invitation and adds the user to the workspace.

Revoke invitation

Section titled “Revoke invitation”
DELETE /api/invitations/{id}

Other endpoints

Section titled “Other endpoints”

Upload attachment

Section titled “Upload attachment”
POST /api/attachments

Upload a file attachment for use in chat messages. Files are stored in Cloudflare R2.

Get attachment

Section titled “Get attachment”
GET /api/attachments?key=attachment-key

Retrieve an uploaded attachment by its storage key.

User settings

Section titled “User settings”
GET /api/settings
PUT /api/settings

Key-value store for user preferences.

Available models

Section titled “Available models”
GET /api/models

Returns the list of available AI models and their pricing.

Integrations

Section titled “Integrations”
GET /api/integrations

Returns connected third-party integrations and their status.