Projects

Create a new project (use case)

Changed on

Creates a new project with associated members and frameworks. If an approval_workflow_id is provided, framework creation is deferred until the approval request is approved.

post/projects

Request

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

Request body

project_titlestring required
ownerinteger required
start_datestring date-time required
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

is_organizationalboolean
membersinteger[]
frameworkinteger[] required
approval_workflow_idinteger nullable
enable_ai_data_insertionboolean

Example request

{
  "project_title": "Customer Support Chatbot",
  "owner": 1,
  "start_date": "2026-01-15T00:00:00.000Z",
  "geography": 1,
  "high_risk_roles": [
    "Provider",
    "Deployer"
  ],
  "goal": "Automate tier-1 support queries",
  "target_industry": "Financial Services",
  "description": "An LLM-powered chatbot for handling customer inquiries",
  "members": [
    2,
    3,
    5
  ],
  "framework": [
    1,
    2
  ]
}

Response

Project created successfully

messagestring

Example response

{
  "message": "Created",
  "data": {
    "project": {
      "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/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