Skip to main content
POST
/
orgs
/
{org_id}
/
projects
/
{project_id}
/
workforce
cURL
curl --request POST \
  --url https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/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
​
project_id
string
required

Query Parameters

​
rev
string
required

Git branch name (for example main).

Body

application/json
​
name
string | null

Optional display name for the new component. If omitted, a unique name is generated.

​
type
string

Either 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

Path to the new component inside the repository worktree (for example workforce/my-agent).

​
type
string
required
​
uid
string
required

Identifier assigned in the project manifest for this component.