Update Project

PUThttps://api.confident-ai.com/v2/projects/{projectId}

Renames a project or changes its description, and returns the project as stored. Send at least one field; a field you omit is left as it is. A name already taken by another project in the organization is refused.

PUT/v2/projects/{projectId}

curl -X PUT "https://api.confident-ai.com/v2/projects/{projectId}" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Customer Support Agent",
  "description": "The support chatbot serving acme.com."
}'

200

{
  "success": true,
  "data": {
    "id": "<PROJECT-ID>",
    "name": "Customer Support Agent",
    "description": "The support chatbot serving acme.com.",
    "organizationId": "<ORGANIZATION-ID>",
    "created_at": "2025-01-14T09:30:00.000Z",
    "governancePolicy": {
      "id": "<GOVERNANCE-POLICY-ID>",
      "name": "EU AI Act"
    }
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

projectIdstringRequired
The id of the project. It must belong to the organization your API key is scoped to.

Request body

namestring
The name of the project, which must not already be taken by another project in the organization.
descriptionstring
What the project covers.

Response

Update Project succeeded.

successboolean
Indicates if the request was successful.
dataobject
A workspace inside your organization. A project owns its own API keys, members, datasets, prompts, metrics and traces, and every project-scoped endpoint reads and writes within exactly one of them.
Show 6 propertiesHide 6 properties
- idstring
  The id of the project, generated by Confident AI.
- namestring
  The name of the project, unique within the organization.
- descriptionstring | null
  What the project covers, or null when it has no description.
- organizationIdstring
  The id of the organization the project belongs to.
- created_atstring
  When the project was created.
- governancePolicyobject | null
  The governance policy a project is enrolled in, named rather than resolved. Retrieve the policy itself to see the controls it enforces.
  Show 2 propertiesHide 2 properties
  - idstring
    The id of the governance policy, generated by Confident AI.
  - namestring
    The name of the governance policy.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI