Skip to main content
PATCH
/
api
/
v1
/
projects
/
{project_id}
Update Project
curl --request PATCH \
  --url https://control-plane.kubiya.ai/api/v1/projects/{project_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "key": "<string>",
  "description": "<string>",
  "goals": "<string>",
  "settings": {},
  "status": "<string>",
  "visibility": "<string>",
  "restrict_to_environment": true,
  "policy_ids": [
    "<string>"
  ],
  "default_model": "<string>"
}
'
{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "key": "<string>",
  "description": "<string>",
  "goals": "<string>",
  "settings": {},
  "status": "<string>",
  "visibility": "<string>",
  "owner_id": "<string>",
  "owner_email": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "archived_at": "<string>",
  "restrict_to_environment": false,
  "policy_ids": [],
  "default_model": "<string>",
  "agent_count": 0,
  "team_count": 0
}

Authorizations

​
Authorization
string
header
required

Enter your Kubiya API token (format: Bearer )

Path Parameters

​
project_id
string
required

Body

application/json
​
name
string | null
​
key
string | null
​
description
string | null
​
goals
string | null
​
settings
Settings · object
​
status
string | null
​
visibility
string | null
​
restrict_to_environment
boolean | null
​
policy_ids
string[] | null
​
default_model
string | null

Response

Successful Response

​
id
string
required
​
organization_id
string
required
​
name
string
required
​
key
string
required
​
description
string | null
required
​
goals
string | null
required
​
settings
Settings · object
required
​
status
string
required
​
visibility
string
required
​
owner_id
string | null
required
​
owner_email
string | null
required
​
created_at
string
required
​
updated_at
string
required
​
archived_at
string | null
required
​
restrict_to_environment
boolean
default:false
​
policy_ids
string[]
​
default_model
string | null
​
agent_count
integer
default:0
​
team_count
integer
default:0