Skip to main content
A workspace groups providers, models, prompts, mappings, and workflows. Reads need workspaces:read and writes need workspaces:write. Member and budget actions have their own scopes and roles, noted below.

List workspaces

Each row carries my_role, an owner, and a stats summary. owner_id and owner are null for a workspace with no owner.

Get a workspace

Create a workspace

string
required
A name for the workspace, from 1 to 128 characters.
Workspaces you own count against your plan’s workspace limit, the same as in the console. Past it, the request answers 403 with You've reached a limit on your plan.

Update a workspace

string
A new name for the workspace.
SDK

Delete a workspace

Only the owner can delete a workspace.
SDK

Members

Reads need members:read and writes need members:write.

List members

Invite a member

Creates an invitation and returns a shareable link.
string[]
Limit the invite to specific email addresses.
integer
How many times the invite can be redeemed.
integer
How many days the invite stays valid.

Update a member role

string
required
ADMIN or MEMBER. ADMIN is the built-in Admin role; extra roles created under Team, Roles are managed in the console.

Remove a member

Budget

The monthly spend cap for a workspace. Reading needs the “View budget” permission and updating needs “Manage budget”; by default both mean the owner or an admin. Anyone else gets 403.

Get the budget

This endpoint does not use the data envelope.

Update the budget

number
required
The monthly cap, from 0 to 1000000.

Gateway token

Mints a short lived gateway key so a workspace can send inference through the gateway. This endpoint authenticates with your app credentials rather than a bearer token, so reach for the SDK, which handles it for you.
SDK