---
canonical_url: "https://docs.composio.dev/toolkits/openlayer"
markdown_url: "https://docs.composio.dev/toolkits/openlayer.md"
product: "platform"
version: null
last_updated: null
---

# Openlayer

Openlayer is an AI quality platform for managing projects, monitoring production data, evaluating tests, and inspecting model and application performance.

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `OPENLAYER`
- **Version:** 00000000_00

## Tools

### Get Data Source

**Slug:** `OPENLAYER_GET_DATA_SOURCE`

Return one Openlayer monitoring data source, including its backend, monitoring status, record and test counts, and optional project or workspace details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Related objects to include in the response. Use project, workspace, or both. |
| `data_source_id` | string | Yes | Data source ID returned by List Data Sources. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project Version

**Slug:** `OPENLAYER_GET_PROJECT_VERSION`

Return one Openlayer project commit or version with its processing status, commit metadata, storage URI, and passing, failing, and total test counts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_version_id` | string | Yes | Project version ID returned by List Project Versions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace

**Slug:** `OPENLAYER_GET_WORKSPACE`

Return a workspace's identity, status, connected-account membership, usage counts, and plan limits. Obtain workspace_id from List Projects first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Workspace ID, available as workspace_id in a project returned by List Projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Data Sources

**Slug:** `OPENLAYER_LIST_DATA_SOURCES`

Return one page of monitoring data sources for an Openlayer project, optionally filtered by name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filter data sources by name. |
| `per_page` | integer | No | Maximum data sources to return on this page (1-100). |
| `project_id` | string | Yes | Project ID whose monitoring data sources to list. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Data Source Test Results

**Slug:** `OPENLAYER_LIST_DATA_SOURCE_TEST_RESULTS`

Return one page of the latest monitoring test results for an Openlayer data source, optionally filtered by test category or execution status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("integrity" | "consistency" | "performance" | "fairness" | "robustness") | No | Filter results by test category. |
| `status` | string ("running" | "passing" | "failing" | "skipped" | "error") | No | Filter results by execution status. |
| `per_page` | integer | No | Maximum results to return on this page (1-100). |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `data_source_id` | string | Yes | Data source ID whose latest monitoring test results to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `OPENLAYER_LIST_PROJECTS`

Return one page of projects visible to the connected Openlayer workspace, optionally filtered by name or task type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filter projects by name. |
| `per_page` | integer | No | Maximum projects to return in this page (1-100). |
| `task_type` | string ("llm-base" | "tabular-classification" | "tabular-regression" | "text-classification") | No | Filter projects by Openlayer task type. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Versions

**Slug:** `OPENLAYER_LIST_PROJECT_VERSIONS`

Return one page of commits and versions for an Openlayer project, including processing status, commit metadata, and passing, failing, and total test counts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `per_page` | integer | No | Maximum project versions to return on this page (1-100). |
| `project_id` | string | Yes | Project ID whose commits and versions to list. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Version Test Results

**Slug:** `OPENLAYER_LIST_PROJECT_VERSION_TEST_RESULTS`

Return one page of test results for a project version, optionally filtered by test category, archive state, or result status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("integrity" | "consistency" | "performance" | "fairness" | "robustness") | No | Filter results by test category. |
| `status` | string ("running" | "passing" | "failing" | "skipped" | "error") | No | Filter results by execution status. |
| `per_page` | integer | No | Maximum results to return in this page (1-100). |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `include_archived` | boolean | No | Whether to include archived test results. |
| `project_version_id` | string | Yes | Project version ID whose test results to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Test Results

**Slug:** `OPENLAYER_LIST_TEST_RESULTS`

Return one page of results for a test, with optional project-version, data-source, and status filters and optional generated insights.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | array | No | Result statuses to include. Values are sent as repeated status query parameters. |
| `test_id` | string | Yes | Test ID returned by List Tests. |
| `per_page` | integer | No | Maximum results to return in this page (1-100). |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `data_source_id` | string | No | Limit results to this monitoring data source. |
| `include_insights` | boolean | No | Whether to include generated result insights when available. |
| `project_version_id` | string | No | Limit results to this project version. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tests

**Slug:** `OPENLAYER_LIST_TESTS`

Return one page of tests configured for an Openlayer project, with filters for category, archive state, origin version, production-data use, and suggested status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("integrity" | "consistency" | "performance" | "fairness" | "robustness") | No | Filter tests by category. |
| `per_page` | integer | No | Maximum tests to return in this page (1-100). |
| `suggested` | boolean | No | Filter by whether Openlayer marks the test as suggested. |
| `project_id` | string | Yes | Project ID whose tests to list. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `include_archived` | boolean | No | Whether to include archived tests. |
| `origin_version_id` | string | No | Filter to tests originating from this project version ID. |
| `uses_production_data` | boolean | No | Filter by whether the test uses production data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |