Retrieve Project

GEThttps://api.confident-ai.com/v1/projects/{projectId}

Retrieves a single project by id. The project must belong to the organization the API key is scoped to.

GET/v1/projects/{projectId}

curl -X GET "https://api.confident-ai.com/v1/projects/{projectId}" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"

200

{
  "success": true,
  "data": {
    "project": {
      "id": "PROJECT-ID",
      "name": "Production App",
      "description": "Main production application",
      "organizationId": "ORGANIZATION-ID",
      "created_at": "2024-12-04T23:00:00.000Z"
    }
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

projectIdstringRequired
The unique identifier of the project to retrieve.

Response

successboolean
Indicates if the request was successful
dataobject
Show 1 propertyHide 1 property
- 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.

Built byConfident AI