Skip to main content
cURL

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

​
frameworkId
string<uuid>
required

The framework id.

Response

Status OK.

​
id
string<uuid>
required
read-only

The framework id.

Example:

"9f1b3c2d-4e5a-4f60-8a71-2b3c4d5e6f70"

​
workspaceId
string<uuid>
required
read-only

The id of the workspace the framework belongs to.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
name
string
required

The framework name.

Maximum string length: 255
Example:

"EU AI Act"

​
enabled
boolean
default:false
required

Whether the framework is active. Rules of a disabled framework are not evaluated and do not count towards compliance.

​
tags
string[]
required

Free-form labels on the framework.

Example:
​
dateCreated
string<date-time>
required
read-only

The creation date.

Example:

"2026-03-22T11:31:01.185Z"

​
dateUpdated
string<date-time>
required
read-only

The last update date.

Example:

"2026-03-22T11:31:01.185Z"

​
creatorId
string<uuid> | null
read-only

The user who created the framework. null for built-in frameworks.

​
description
string | null

A short description of the framework.

Maximum string length: 5000
Example:

"Requirements for high-risk AI systems under the EU AI Act."

​
extendedDescription
object | null

A longer, rich-text description, as a TipTap JSON document.

​
href
string | null

A link to the external standard or regulation the framework is based on.

Maximum string length: 2048
​
avatar
object | null

The icon shown for the framework.

​
builtInSlug
string | null

Identifies a framework that ships with Openlayer, for example eu_ai_act, iso_42001, nist_ai_rmf, or traiga. null for frameworks you create yourself.

Example:

"eu_ai_act"

​
immutable
boolean
read-only

Whether the framework definition is managed by Openlayer and cannot be edited.

​
projectSelector
object | null

Determines which projects the framework applies to. An empty or null match array applies the framework to every project in the workspace.

​
ruleStats
object

Compliance roll-up for the framework. Present only on GET /workspaces/{workspaceId}/frameworks when the request sets includeRuleStats=true.