{"openapi":"3.1.0","info":{"title":"Openlayer AI projects, tests, commits, monitoring and governance rules (your key) API","version":"0.1.0","description":"Openlayer AI projects, tests, commits, monitoring and governance rules (your key) lets an AI assistant read your own Openlayer data through the Openlayer API with a key you supply (Openlayer API key). Read-only: 11 tools (list_projects, get_workspace, list_tests, list_test_results, list_project_commits, list_data_sources, get_data_source, list_frameworks, list_rules, list_rule_results,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-openlayer.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-openlayer/docs"},"termsOfService":"https://connectorbay.com/byok-openlayer/terms"},"servers":[{"url":"https://byok-openlayer.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-openlayer/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_projects":{"post":{"operationId":"list_projects","summary":"List the workspace's Openlayer projects with task type, counts of commits, data sources and tests, and dates. Use for \"W","description":"List the workspace's Openlayer projects with task type, counts of commits, data sources and tests, and dates. Use for \"Which Openlayer projects do I have and how many tests does each run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only projects with this exact name.","title":"Name"},"task_type":{"anyOf":[{"enum":["llm-base","tabular-classification","tabular-regression","text-classification"],"type":"string"},{"type":"null"}],"default":null,"description":"Only projects of this task type.","title":"Task Type"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page.","title":"Per Page"}},"title":"list_projectsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_workspace":{"post":{"operationId":"get_workspace","summary":"Get an Openlayer workspace: project and member counts, billing status, current period and monthly prediction usage. Use ","description":"Get an Openlayer workspace: project and member counts, billing status, current period and monthly prediction usage. Use for \"How many projects and members does my Openlayer workspace have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id (shown as workspaceId on projects).","maxLength":200,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"get_workspaceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_tests":{"post":{"operationId":"list_tests","summary":"List the tests (goals) of a project: type, subtype, thresholds, evaluation window, whether they run on production data, ","description":"List the tests (goals) of a project: type, subtype, thresholds, evaluation window, whether they run on production data, and archived flag. Use for \"Which tests does my Openlayer project run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Project id from list_projects.","maxLength":200,"title":"Project Id","type":"string"},"type":{"anyOf":[{"enum":["integrity","consistency","performance","fairness","robustness"],"type":"string"},{"type":"null"}],"default":null,"description":"Only tests of this type.","title":"Type"},"uses_production_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for monitoring tests that run on production data.","title":"Uses Production Data"},"include_archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include archived tests.","title":"Include Archived"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page.","title":"Per Page"}},"required":["project_id"],"title":"list_testsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_test_results":{"post":{"operationId":"list_test_results","summary":"List the results of one test over time: pass or fail status, status message, data window and expected value ranges. Use ","description":"List the results of one test over time: pass or fail status, status message, data window and expected value ranges. Use for \"Is my Openlayer test passing and when did it last fail\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"test_id":{"description":"Test id from list_tests.","maxLength":200,"title":"Test Id","type":"string"},"project_version_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only results for this project commit id.","title":"Project Version Id"},"inference_pipeline_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only results for this data source id.","title":"Inference Pipeline Id"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page.","title":"Per Page"}},"required":["test_id"],"title":"list_test_resultsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_project_commits":{"post":{"operationId":"list_project_commits","summary":"List a project's commits (versions) with build status and counts of passing, failing and total tests. Use for \"Which com","description":"List a project's commits (versions) with build status and counts of passing, failing and total tests. Use for \"Which commits of my Openlayer project have failing tests\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Project id from list_projects.","maxLength":200,"title":"Project Id","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page.","title":"Per Page"}},"required":["project_id"],"title":"list_project_commitsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_data_sources":{"post":{"operationId":"list_data_sources","summary":"List a project's monitored data sources (inference pipelines) with record counts, last sample time and passing and faili","description":"List a project's monitored data sources (inference pipelines) with record counts, last sample time and passing and failing test counts. Use for \"Which monitored data sources of my Openlayer project are failing tests\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Project id from list_projects.","maxLength":200,"title":"Project Id","type":"string"},"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only data sources with this exact name.","title":"Name"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page.","title":"Per Page"}},"required":["project_id"],"title":"list_data_sourcesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_data_source":{"post":{"operationId":"get_data_source","summary":"Get one monitored data source: status, record count, last sample time and test counts. Use for \"How many records has my ","description":"Get one monitored data source: status, record count, last sample time and test counts. Use for \"How many records has my Openlayer data source received\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"data_source_id":{"description":"Data source (inference pipeline) id.","maxLength":200,"title":"Data Source Id","type":"string"}},"required":["data_source_id"],"title":"get_data_sourceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_frameworks":{"post":{"operationId":"list_frameworks","summary":"List governance and compliance frameworks of a workspace with enabled flag, tags and optional rule result counts. Use fo","description":"List governance and compliance frameworks of a workspace with enabled flag, tags and optional rule result counts. Use for \"Which compliance frameworks are enabled in my Openlayer workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id.","maxLength":200,"title":"Workspace Id","type":"string"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for enabled frameworks only, false for disabled ones.","title":"Enabled"},"include_rule_stats":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to add rule result counts to each framework.","title":"Include Rule Stats"},"search_query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search over names and descriptions.","title":"Search Query"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page.","title":"Per Page"}},"required":["workspace_id"],"title":"list_frameworksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_rules":{"post":{"operationId":"list_rules","summary":"List governance rules of a workspace (platform-checked or evidence-based) with scope, type, renewal cadence and deactiva","description":"List governance rules of a workspace (platform-checked or evidence-based) with scope, type, renewal cadence and deactivated flag. Use for \"Which governance rules apply to my Openlayer workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id.","maxLength":200,"title":"Workspace Id","type":"string"},"framework_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only rules of this framework id.","title":"Framework Id"},"project_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only rules that apply to this project id.","title":"Project Id"},"search_query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search over names and descriptions.","title":"Search Query"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page.","title":"Per Page"}},"required":["workspace_id"],"title":"list_rulesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_rule_results":{"post":{"operationId":"list_rule_results","summary":"List governance rule results with compliance status (passing, failing, pending, due soon), last evaluation time and next","description":"List governance rule results with compliance status (passing, failing, pending, due soon), last evaluation time and next renewal. Use for \"Which governance rules are failing in my Openlayer workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id.","maxLength":200,"title":"Workspace Id","type":"string"},"framework_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only results of this framework id.","title":"Framework Id"},"project_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only results for this project id.","title":"Project Id"},"rule_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only results of this rule id.","title":"Rule Id"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page.","title":"Per Page"}},"required":["workspace_id"],"title":"list_rule_resultsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_compliance_stats":{"post":{"operationId":"get_compliance_stats","summary":"Get compliance statistics of a workspace: rule counts by type and scope and rule result counts by status. Use for \"How c","description":"Get compliance statistics of a workspace: rule counts by type and scope and rule result counts by status. Use for \"How compliant is my Openlayer workspace overall\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id.","maxLength":200,"title":"Workspace Id","type":"string"},"framework_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only count items of this framework id.","title":"Framework Id"},"project_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only count items of this project id.","title":"Project Id"}},"required":["workspace_id"],"title":"get_compliance_statsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}