Skip to main content
POST
/
orgs
/
{org_id}
/
projects
/
{project_id}
/
envs
/
{env}
/
workforce
cURL
curl --request POST \
  --url https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/envs/{env}/workforce \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "path": "<string>",
  "type": "<string>",
  "uid": "<string>"
}

Authorizations

​
Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

​
org_id
string
required

Organization identifier

​
project_id
string
required

Project identifier

​
env
string
required

Environment id or branch name

Body

application/json
​
name
string | null

Display name (e.g. "email-summary"). If omitted, a random name is generated.

​
type
string

Component type: "agent" or "workflow". Defaults to "agent".

Response

201 - application/json

Workforce component created

Response returned when a new workforce component is created.

​
id
string
required
​
name
string
required
​
path
string
required

Relative path in the worktree, e.g. "workforce/jolly-ferret"

​
type
string
required
​
uid
string
required