List Projects
List all projects within an organization.Path Parameters
The unique identifier of the organization
Response
Array of project objects with membership details
Create Project
Create a new project within an organization.Path Parameters
The unique identifier of the organization
Request Body
Project name
Project description
Array of domains allowed for this project (e.g., [“example.com”, “subdomain.example.com”])
Response
Returns the created project object with membership details.Get Project
Get a single project by ID.Path Parameters
The unique identifier of the organization
The unique identifier of the project
Response
Returns the project object with membership details.Update Project
Update an existing project.Path Parameters
The unique identifier of the organization
The unique identifier of the project
Request Body
Updated project name
Updated project description
Updated array of domains allowed for this project
Response
Returns the updated project object.Delete Project
Delete a project. This action cannot be undone and will remove all associated agents, datasources, and other project resources.Path Parameters
The unique identifier of the organization
The unique identifier of the project
Response
Returns a 204 status code on successful deletion.Get Project Statistics
Get statistics and metrics for a project.Path Parameters
The unique identifier of the organization
The unique identifier of the project
Response
Total number of agents in the project
Total number of datasources in the project
Total number of resources across all datasources
Total number of tools in the project
Total number of API requests made in the project
List Project Members
List all members of a project.Path Parameters
The unique identifier of the organization
The unique identifier of the project
Response
Array of member objects
Project Roles
Projects support a hierarchical role-based access control system:OWNER
OWNER
- Full control over the project
- Can delete the project
- Can manage all members and their roles
- Can modify all project settings
- Can access all project resources
ADMIN
ADMIN
- Can manage project settings (except deletion)
- Can invite and remove members
- Can modify member roles (except OWNER)
- Can access all project resources
- Can create and modify agents, tools, and datasources
MEMBER
MEMBER
- Can create and modify agents, tools, and datasources
- Can access project resources based on permissions
- Cannot manage project settings or members
- Can view project statistics
VIEWER
VIEWER
- Read-only access to project resources
- Can view agents, tools, and datasources
- Cannot create or modify any resources
- Can view project statistics
Each project membership includes an API token that can be used for programmatic access to the project’s resources. This token inherits the permissions of the user’s role in the project.