Update Policy

PUThttps://api.confident-ai.com/v2/organization/governance-policies/{policyId}

Changes a governance policy's name, description, owner, or the policies it extends, and returns the policy in full. Only the fields you send are touched. ownerEmail must name a member of this organization. basePolicyIds replaces the whole inheritance list rather than adding to it, and is held to the two-level rule: a policy that other policies extend cannot start extending anything, and no id you send may name a policy that already extends another. That check and the write run in a single serializable transaction, so a concurrent edit cannot produce an inheritance cycle by passing a guard that was true a moment earlier; when two such writes do collide, the loser is rejected and can be retried.

PUT/v2/organization/governance-policies/{policyId}

curl -X PUT "https://api.confident-ai.com/v2/organization/governance-policies/{policyId}" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "EU AI Act readiness",
  "description": "The checks every customer-facing agent must pass before release.",
  "ownerEmail": "jane@acme.com",
  "basePolicyIds": [
    "<GOVERNANCE-POLICY-ID>"
  ]
}'

200

{
  "success": true,
  "data": {
    "id": "<GOVERNANCE-POLICY-ID>",
    "name": "EU AI Act readiness",
    "description": "The checks every customer-facing agent must pass before release.",
    "recommended": false,
    "projectsCount": 4,
    "controlsCount": 6,
    "documentsCount": 2,
    "createdAt": "2025-01-14T09:30:00.000Z",
    "updatedAt": "2025-01-15T11:00:00.000Z",
    "owner": {
      "id": "<USER-ID>",
      "email": "jane@acme.com",
      "name": "Jane Doe",
      "image": null
    },
    "skill": {
      "description": "Rules for shipping changes to an AI system governed for EU AI Act readiness.",
      "body": "## Before opening a pull request\n\n- Run the project's evals and attach the test run link.\n- Never disable a governance control to make a build pass.\n"
    },
    "controls": [
      {
        "id": "<GOVERNANCE-CONTROL-ID>",
        "name": "Groundedness above 0.9",
        "description": "Answers must stay grounded in the retrieved context.",
        "type": "RUNTIME",
        "recommended": true,
        "configured": true,
        "currentVersion": {
          "id": "<GOVERNANCE-CONTROL-VERSION-ID>",
          "version": "00.00.02"
        },
        "latestAssessments": [
          {
            "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"
          }
        ],
        "baseGovernancePolicy": {
          "id": "<GOVERNANCE-POLICY-ID>",
          "name": "EU AI Act readiness"
        },
        "alsoInBaseGovernancePolicy": {
          "id": "<GOVERNANCE-POLICY-ID>",
          "name": "EU AI Act readiness"
        }
      }
    ],
    "projects": [
      {
        "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
        },
        "latestAssessments": [
          {
            "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"
          }
        ]
      }
    ],
    "basePolicies": [
      {
        "id": "<GOVERNANCE-POLICY-ID>",
        "name": "EU AI Act readiness"
      }
    ],
    "childrenPolicies": [
      {
        "id": "<GOVERNANCE-POLICY-ID>",
        "name": "EU AI Act readiness"
      }
    ]
  },
  "link": "https://app.confident-ai.com/organization/<ORGANIZATION-ID>/governance/policies/<GOVERNANCE-POLICY-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

policyIdstringRequired
The id of the governance policy.

Request body

namestring
The name of the governance policy, unique within your organization.
descriptionstring | null
What the policy covers. Send null to clear it.
ownerEmailstring | null
The email address of the organization member who should own the policy. They must already be a member of this organization. Send null to leave the policy unowned.
basePolicyIdslist of strings
Replaces the full list of policies this policy extends, so send every id you want kept and an empty array to stop extending anything. Inheritance is exactly two levels deep: a policy that is itself extended cannot start extending, and no id here may name a policy that extends another.

Response

Update Policy succeeded.

successboolean
Indicates if the request was successful.
dataobject
A governance policy in full: the controls it applies, the projects enrolled in it, the policies above and below it in the inheritance chain, and the Agent Skill it serves. A policy may extend other policies and inherit their controls, and that chain is exactly two levels deep — a policy that is extended by another cannot extend anything itself.
Show 15 propertiesHide 15 properties
- idstring
  The id of the governance policy, generated by Confident AI.
- namestring
  The name of the governance policy.
- descriptionstring | null
  What the policy covers, or null when it has no description.
- recommendedboolean
  Whether Confident AI seeded this policy as a recommended starting point rather than your organization authoring it.
- projectsCountinteger
  How many projects are enrolled in this policy.
- controlsCountinteger
  How many controls apply to this policy, counting the ones inherited from the policies it extends.
- documentsCountinteger
  How many source documents have been uploaded to this policy, which Confident AI reads when it drafts controls for it.
- createdAtstring
  When the policy was created.
- updatedAtstring
  When the policy was last changed.
- 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.
- skillobject | null
  An Agent Skill attached to a governance policy: the instructions Confident AI serves to coding agents working on the projects the policy governs. Confident AI publishes a per-project Agent Skills git repository at https://app.confident-ai.com/skills.git, and a project enrolled in this policy finds the skill there as skills/governance/SKILL.md, with description in the YAML frontmatter and body as the Markdown beneath it. Nothing about the skill is assessed — it instructs the agent, it is not a control.
  Show 2 propertiesHide 2 properties
  - descriptionstring
    One line on what the skill covers, which is how a coding agent decides whether it is relevant to the task in front of it.
  - bodystring
    The instructions themselves, in Markdown. This becomes the body of the SKILL.md file, so write it for a coding agent rather than a person and be as explicit as the policy requires.
- controlslist of objects
  Every control that applies to this policy's projects, including the ones inherited from the policies it extends, each with its latest verdict per enrolled project.
  Show 10 propertiesHide 10 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
  - recommendedboolean
    Whether Confident AI recommends this control for the kind of system the policy governs.
  - configuredboolean
    Whether the control's current version carries the settings its type needs to run. A control that is not configured is never assessed, so it produces no verdicts.
  - 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.
  - latestAssessmentslist of objects
    This control's newest verdict in each project enrolled in the policy. A project with no verdict for the control is absent rather than listed with a null status.
    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.
  - 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.
- projectslist of objects
  The projects enrolled in this policy, each with its latest verdict per control.
  Show 5 propertiesHide 5 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.
  - latestAssessmentslist of objects
    This project's newest verdict for each control the policy applies. A control with no verdict yet is absent rather than listed with a null status.
    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.
- basePolicieslist of objects
  The policies this policy extends. Their controls apply to this policy's projects but are attached and detached on the base policy, not here.
  Show 2 propertiesHide 2 properties
  - idstring
    The id of the governance policy.
  - namestring
    The name of the governance policy.
- childrenPolicieslist of objects
  The policies that extend this one. While this list is not empty the policy cannot be deleted and cannot itself start extending another policy.
  Show 2 propertiesHide 2 properties
  - idstring
    The id of the governance policy.
  - namestring
    The name of the governance policy.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI