Create Project

POSThttps://api.confident-ai.com/v1/projects

Creates a new project within your organization. A default project-scoped API key is provisioned with the project — its full value is returned once in this response. Optionally pass email to assign an existing organization member (by email) as the project's Owner.

POST/v1/projects

curl -X POST "https://api.confident-ai.com/v1/projects" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "New Project",
  "description": "This is a new project for testing"
}'

200

{
  "success": true,
  "data": {
    "project": {
      "id": "PROJECT-ID",
      "name": "New Project",
      "description": "This is a new project for testing",
      "organizationId": "ORGANIZATION-ID",
      "created_at": "2024-12-04T23:00:00.000Z"
    },
    "apiKey": {
      "id": 12,
      "name": "Default Key",
      "valid": true,
      "value": "confident_proj_9b8a7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
      "created_at": "2024-12-04T23:00:00.000Z",
      "lastUsed": null
    }
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Request body

namestringRequired
Name of the project (must be unique within the organization)
descriptionstring
Optional description of the project
emailstring
Optional email of an existing organization member to assign as the project's Owner. If omitted, the project has no member and is accessible via its API key and to organization admins.

Response

successboolean
Indicates if the request was successful
dataobject
Show 2 propertiesHide 2 properties
- projectobject
  Show 6 propertiesHide 6 properties
  - idstring
    Unique identifier for the project
  - namestring
    Name of the project
  - descriptionstring
    Optional description of the project
  - organizationIdstring
    ID of the organization this project belongs to
  - created_atstring
    ISO 8601 timestamp of when the project was created
  - governancePolicyobject
    The governance policy the project is enrolled in, or null if it is not enrolled.
    Show 2 propertiesHide 2 properties
    idstring
    The unique identifier of the governance policy.
    namestring
    The name of the governance policy.
- apiKeyobject
  A default project-scoped API key provisioned with the project. Its full value is returned only once, in this response.
  Show 9 propertiesHide 9 properties
  - idinteger
    Unique identifier for the API key
  - namestring
    Human-readable label for the API key
  - validboolean
    Whether the key is active. A deactivated key is rejected on authentication.
  - valuestring
    The API key value. This is redacted (only the last 6 characters are shown, prefixed with asterisks) on every response except the create response — and the rotate response when rotating without a grace period — where the full value is returned exactly once.
  - shadowValuestring
    The replacement value while a rotation's grace period is running, or null when no rotation is pending. Redacted on every response except the rotate response that issued it, where the full value is returned exactly once.
  - rotatesAtstring
    ISO 8601 timestamp of when a pending rotation completes and shadowValue replaces value, or null when no rotation is pending
  - expiresAtstring
    ISO 8601 timestamp of when the key expires, or null if it never expires
  - created_atstring
    ISO 8601 timestamp of when the key was created
  - lastUsedstring
    ISO 8601 timestamp of when the key was last used to authenticate, or null if never used

Built byConfident AI