Projects

Update a project by ID

Changed on

Partially updates a project and its member list. Only provided fields are updated.

patch/projects/{id}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/projects/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required
Example:1

The numeric project ID

Request body

project_titlestring
ownerinteger
start_datestring date-time
geographyinteger
ai_risk_classification'Prohibited' | 'High risk' | 'Limited risk' | 'Minimal risk' | 'GPAI' | 'General Risk' | 'Out of scope'

EU AI Act risk classification level

high_risk_rolesHighRiskRole[] nullable

EU AI Act roles of the use case: Provider, Deployer or both. Replaces the stored list; duplicates are removed and the list is stored as Provider, Deployer. null or [] clears it.

type_of_high_risk_role'Deployer' | 'Provider'

Role of the organization under the EU AI Act for high-risk systems

goalstring nullable
target_industrystring nullable
descriptionstring nullable
status'Not started' | 'In progress' | 'Under review' | 'Completed' | 'Closed' | 'On hold' | 'Rejected'

Current lifecycle status of the project

last_updatedstring date-time
last_updated_byinteger
membersinteger[]

Example request

{
  "high_risk_roles": [
    "Provider",
    "Deployer"
  ],
  "members": [
    2,
    3,
    5
  ]
}

Response

Project updated successfully

messagestring

Example response

{
  "message": "Accepted",
  "data": {
    "id": 42,
    "uc_id": "UC-7",
    "project_title": "Customer Support Chatbot",
    "owner": 1,
    "geography": 1,
    "high_risk_roles": [
      "Provider",
      "Deployer"
    ],
    "framework": [
      {
        "name": "EU AI Act"
      }
    ]
  }
}

Changes

  • 8654cd67799eRevision changes
    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value Deployer of the request property

    • breaking

      removed the enum value Provider of the request property

    • breaking

      the request property type changed from string to no type

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      request property deprecated

    • info

      added the optional property ///// to the response with the status

    • info

      response property data/allOf[Project]/type_of_high_risk_role deprecated

  • ba4e6d04f6a5Revision changes
    • warning

      added the new Out of scope enum value to the ///////// response property for the response status

    • info

      added the new Out of scope enum value to the request property