List frameworks - Openlayer

cURL

curl --request GET \
  --url 'https://api.openlayer.com/v1/workspaces/3fa85f64-5717-4562-b3fc-2c963f66afa6/frameworks?enabled=true' \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "9f1b3c2d-4e5a-4f60-8a71-2b3c4d5e6f70",
      "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "EU AI Act",
      "enabled": false,
      "tags": [
        "regulation",
        "eu"
      ],
      "dateCreated": "2026-03-22T11:31:01.185Z",
      "dateUpdated": "2026-03-22T11:31:01.185Z",
      "creatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "Requirements for high-risk AI systems under the EU AI Act.",
      "extendedDescription": {},
      "href": "<string>",
      "avatar": {
        "type": "emoji",
        "value": "🧭"
      },
      "builtInSlug": "eu_ai_act",
      "immutable": true,
      "projectSelector": {
        "match": [
          {
            "property": "riskLevel",
            "value": [
              "high",
              "critical"
            ]
          }
        ]
      },
      "ruleStats": {
        "ruleResults": {
          "total": 1,
          "totalPassing": 1,
          "totalFailing": 1,
          "totalSkipped": 1,
          "totalRunning": 1,
          "totalError": 1,
          "totalPending": 1,
          "totalDueSoon": 1
        },
        "projectCompletion": {
          "high": 1,
          "mid": 1,
          "low": 1
        }
      }
    }
  ]
}

{
  "code": 123,
  "error": "<string>"
}

cURL

curl --request GET \
  --url 'https://api.openlayer.com/v1/workspaces/3fa85f64-5717-4562-b3fc-2c963f66afa6/frameworks?enabled=true' \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "9f1b3c2d-4e5a-4f60-8a71-2b3c4d5e6f70",
      "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "EU AI Act",
      "enabled": false,
      "tags": [
        "regulation",
        "eu"
      ],
      "dateCreated": "2026-03-22T11:31:01.185Z",
      "dateUpdated": "2026-03-22T11:31:01.185Z",
      "creatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "Requirements for high-risk AI systems under the EU AI Act.",
      "extendedDescription": {},
      "href": "<string>",
      "avatar": {
        "type": "emoji",
        "value": "🧭"
      },
      "builtInSlug": "eu_ai_act",
      "immutable": true,
      "projectSelector": {
        "match": [
          {
            "property": "riskLevel",
            "value": [
              "high",
              "critical"
            ]
          }
        ]
      },
      "ruleStats": {
        "ruleResults": {
          "total": 1,
          "totalPassing": 1,
          "totalFailing": 1,
          "totalSkipped": 1,
          "totalRunning": 1,
          "totalError": 1,
          "totalPending": 1,
          "totalDueSoon": 1
        },
        "projectCompletion": {
          "high": 1,
          "mid": 1,
          "low": 1
        }
      }
    }
  ]
}

{
  "code": 123,
  "error": "<string>"
}

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

workspaceId

string<uuid>

required

The workspace id.

Query Parameters

page

integer

default:1

The page to return in a paginated query.

Required range: x >= 1

perPage

integer

default:25

Maximum number of items to return per page.

Required range: 1 <= x <= 100

searchQuery

string

Filter by a free-text search over names and descriptions.

projectId

string<uuid>

Only include items that apply to this project.

asc

boolean

default:true

Whether to sort in ascending order.

includeRuleStats

boolean

default:false

Whether to include a ruleStats object on each framework, with its rule result status counts and its per-project completion buckets. Computed over the returned page only.

enabled

boolean

Only include frameworks that are enabled (or disabled).

tags

string[]

Only include frameworks carrying all of these tags.

sortColumn

enum<string>

The column to sort on.

Available options:

name,

enabled,

dateCreated,

dateUpdated,

overallCompletion,

projectCompletionBuckets

completionOperator

enum<string>

How to compare each framework's completion percentage with completionValue. Must be sent together with completionValue.

Available options:

is,

>,

>=,

<,

<=,

!=

completionValue

integer

The completion percentage to compare against, from 0 to 100.

Required range: 0 <= x <= 100

Response

Status OK.

items

object[]

required

Show child attributes