Projects

Projects are named folders inside a workspace for chats, agents and other resources. A resource without project_id sits in the workspace root.

project_id on a chat or agent says which project it is filed in. It is unrelated to a per-chat context variable that happens to be named project_id.


Scopes

ScopeAccess
projects:readList and get projects, and file a chat in one
projects:writeCreate, update and delete projects

The standard key preset holds both. The run-only preset holds projects:read, so chats it starts can be filed in a project.


Endpoints

MethodPathScopePurpose
GET/projectsprojects:readList projects
POST/projects/listprojects:readList projects (JSON body)
GET/projects/{id}projects:readGet a project
POST/projectsprojects:writeCreate a project
PATCH/projects/{id}projects:writeUpdate the fields you send
POST/projects/{id}projects:writeUpdate
DELETE/projects/{id}projects:writeDelete

Lists use cursor pagination.


Project object

FieldTypeDescription
idstringProject ID
namestringDisplay name
descriptionstringLonger text
typestringagent, app, flow or other (default other)
colorstringUI color
iconstringIcon key

Responses also carry the usual record and permission fields (created_at, updated_at, user_id, team_id, visibility, …).

Create and update accept name, description, type, color and icon.

bash
1curl -X POST https://api.inference.sh/projects \2  -H "Authorization: Bearer inf_your_key" \3  -H "Content-Type: application/json" \4  -d '{"name": "Q4 launch", "type": "agent"}'

Filing resources

ResourceHow
Chatproject_id on Create chat or on Run agent when it creates the chat; Set chat project afterwards. Sub-agent chats and branches keep their parent's project
Agentproject_id on Create or update agent template; Move agent to project afterwards

Filter List chats with project_id to list one project's chats.

JavaScript SDK: client.projects has list, get, create, update and delete. Python SDK: call the routes over HTTP and type them with ProjectDTO and ProjectType from inferencesh.types.

we use cookies

we use cookies to ensure you get the best experience on our website. for more information on how we use cookies, please see our cookie policy.

by clicking "accept", you agree to our use of cookies.
learn more.