Get Project

GEThttps://api.confident-ai.com/v2/organization/governance-projects/{projectId}

Retrieves one project's governance view in full: every control its policy applies, including the ones that policy inherits from the policies it extends, and the project's verdict history over the last 30 days, newest first. Several assessments of the same control on the same day are collapsed to the last one, so each control appears at most once per day however often it was recomputed. A project enrolled in no governance policy has no controls to be assessed against and is reported as not found, so use the inventory listing to tell an ungoverned project from one that does not exist.

GET/v2/organization/governance-projects/{projectId}

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

200

{
  "success": true,
  "data": {
    "id": "<PROJECT-ID>",
    "name": "Customer Support Agent",
    "description": "Front-line support assistant for billing questions.",
    "owner": {
      "id": "<USER-ID>",
      "email": "jane@acme.com",
      "name": "Jane Doe",
      "image": null
    },
    "governancePolicy": {
      "id": "<GOVERNANCE-POLICY-ID>",
      "name": "EU AI Act readiness"
    },
    "controls": [
      {
        "id": "<GOVERNANCE-CONTROL-ID>",
        "name": "Groundedness above 0.9",
        "description": "Answers must stay grounded in the retrieved context.",
        "type": "RUNTIME",
        "currentVersion": {
          "id": "<GOVERNANCE-CONTROL-VERSION-ID>",
          "version": "00.00.02"
        },
        "baseGovernancePolicy": {
          "id": "<GOVERNANCE-POLICY-ID>",
          "name": "EU AI Act readiness"
        },
        "alsoInBaseGovernancePolicy": {
          "id": "<GOVERNANCE-POLICY-ID>",
          "name": "EU AI Act readiness"
        }
      }
    ],
    "assessments": [
      {
        "id": "<GOVERNANCE-ASSESSMENT-ID>",
        "governanceControlId": "<GOVERNANCE-CONTROL-ID>",
        "governanceControlVersion": {
          "id": "<GOVERNANCE-CONTROL-VERSION-ID>",
          "version": "00.00.02"
        },
        "projectId": "<PROJECT-ID>",
        "status": "PASS",
        "evidence": {
          "measured": 0.94,
          "threshold": 0.9
        },
        "error": null,
        "createdAt": "2025-01-15T02:00:00.000Z"
      }
    ]
  },
  "link": "https://app.confident-ai.com/organization/<ORGANIZATION-ID>/governance/inventory/<PROJECT-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

projectIdstringRequired
The id of the project.

Response

Get Project succeeded.

successboolean
Indicates if the request was successful.
dataobject
A project's governance view in full: the controls its policy applies and the verdict history behind its status. Only an enrolled project has this view — a project belonging to no governance policy has nothing to assess and is reported as not found.
Show 7 propertiesHide 7 properties
- idstring
  The id of the project.
- namestring
  The name of the project.
- descriptionstring | null
  What the project is for, or null when it has no description.
- ownerobject | null
  A Confident AI user, as referenced by the records they created.
  Show 4 propertiesHide 4 properties
  - idstring
    This is the id of the user.
  - emailstring
    This is the email address of the user.
  - namestring | null
    This is the display name of the user, or null when they have not set one.
  - imagestring | null
    This is the URL of the user's avatar, or null when they have none.
- governancePolicyobject | null
  A governance policy, named by id.
  Show 2 propertiesHide 2 properties
  - idstring
    The id of the governance policy.
  - namestring
    The name of the governance policy.
- controlslist of objects
  Every control that applies to this project, including the ones its policy inherits from the policies it extends.
  Show 7 propertiesHide 7 properties
  - idstring
    The id of the governance control.
  - namestring
    The name of the governance control.
  - descriptionstring | null
    What the control checks, or null when it has no description.
  - typeenum
    What a governance control checks: RUNTIME watches production behaviour, PRE_DEPLOYMENT_EVALS and PRE_DEPLOYMENT_RED_TEAMING gate a release, and OPERATIONAL covers process rather than the system itself.
    Show 4 enum valuesHide 4 enum values
    RUNTIME
    PRE_DEPLOYMENT_EVALS
    PRE_DEPLOYMENT_RED_TEAMING
    OPERATIONAL
  - currentVersionobject | null
    The version of a control's definition an assessment was computed against.
    Show 2 propertiesHide 2 properties
    idstring
    The id of the control version, generated by Confident AI.
    versionstring
    The human-readable label of the control version.
  - baseGovernancePolicyobject
    A governance policy, named by id.
    Show 2 propertiesHide 2 properties
    idstring
    The id of the governance policy.
    namestring
    The name of the governance policy.
  - alsoInBaseGovernancePolicyobject
    A governance policy, named by id.
    Show 2 propertiesHide 2 properties
    idstring
    The id of the governance policy.
    namestring
    The name of the governance policy.
- assessmentslist of objects
  The project's verdict history over the last 30 days, newest first. Several assessments of the same control on the same day are collapsed to the last one, so each control appears at most once per day however often it was recomputed.
  Show 8 propertiesHide 8 properties
  - idstring
    The id of the assessment, generated by Confident AI.
  - governanceControlIdstring
    The id of the governance control that was assessed.
  - governanceControlVersionobject
    The version of a control's definition an assessment was computed against.
    Show 2 propertiesHide 2 properties
    idstring
    The id of the control version, generated by Confident AI.
    versionstring
    The human-readable label of the control version.
  - projectIdstring
    The id of the project the control was assessed against.
  - statusenum
    The verdict of assessing one governance control against a project or organization.
    Show 4 enum valuesHide 4 enum values
    PASS
    FAIL
    ERROR
    NO_DATA
  - evidenceobject | null
  - errorstring | null
    Why the check itself failed to run, or null when it ran. This is set on an ERROR verdict and says nothing about whether the project complies.
  - createdAtstring
    When the assessment was recorded.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI