Skip to main content
Workspaces group projects and the people who can reach them. A project owns a single agent and everything inside it. These endpoints create and administer both, and they are where you get the projectID that almost every other endpoint in this API asks for.

​
Endpoints

​
Project

​
Workspace

​
The hierarchy

An organization contains workspaces. A workspace contains projects. A project owns exactly one agent, along with its playbooks, tools, variables, knowledge base and environments. Most other endpoints in this API take a projectID, which you get by listing the projects in a workspace:

​
What a token can see

A personal access token carries your own access. Listing workspaces returns every workspace your account belongs to, not a subset scoped to the integration, so a script that iterates workspaces will reach further than you might expect. Pin the IDs you mean to operate on rather than discovering them at runtime.

​
Deleting

Deleting a project removes the agent and everything in it, including transcripts. Deleting a workspace removes every project inside it. Neither is recoverable through the API.

​
Where to go next

With a project in hand, build its agent and ship it through environments.