{"openapi":"3.1.0","info":{"title":"Confident AI Workspace (BYOK) API","version":"0.1.0","description":"Confident AI Workspace (BYOK) lets an AI assistant read your own Confident AI Workspace data through the Confident AI Workspace API with a key you supply (Confident AI project API key). Read-only: 7 tools (list_model_costs, list_scheduled_alerts, list_report_templates, list_export_schedules, list_forwarding_connectors, list_mcp_servers, list_ai_connections). The BYOK key travels with each...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-confident-ai-workspace.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-confident-ai-workspace/docs"},"termsOfService":"https://connectorbay.com/byok-confident-ai-workspace/terms"},"servers":[{"url":"https://byok-confident-ai-workspace.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-confident-ai-workspace/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_model_costs":{"post":{"operationId":"list_model_costs","summary":"List the custom model prices of the project (USD per million input and output tokens, model name pattern, provider), new","description":"List the custom model prices of the project (USD per million input and output tokens, model name pattern, provider), newest first; shows whether they are inherited from the organization. Use for \"What custom model prices does my Confident AI project use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many prices per page (1 to 100).","title":"Page Size"},"search_term":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only prices whose match pattern or provider contains this text.","title":"Search Term"}},"title":"list_model_costsArguments","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_scheduled_alerts":{"post":{"operationId":"list_scheduled_alerts","summary":"List the scheduled alerts (name, type such as THRESHOLD or ANOMALY, data model, enabled flag), ordered by name. Use for ","description":"List the scheduled alerts (name, type such as THRESHOLD or ANOMALY, data model, enabled flag), ordered by name. Use for \"Which scheduled alerts are running in my Confident AI project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many alerts per page (1 to 100).","title":"Page Size"},"data_model":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only alerts measuring this kind of item: TRACE, SPAN or THREAD.","title":"Data Model"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for only running alerts, false for only paused ones (leave empty for both).","title":"Enabled"}},"title":"list_scheduled_alertsArguments","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_report_templates":{"post":{"operationId":"list_report_templates","summary":"List the report templates (name, description, report type, enabled flag, creation time), oldest first. Use for \"Which re","description":"List the report templates (name, description, report type, enabled flag, creation time), oldest first. Use for \"Which report templates exist in my Confident AI project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many templates per page (1 to 100).","title":"Page Size"}},"title":"list_report_templatesArguments","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_export_schedules":{"post":{"operationId":"list_export_schedules","summary":"List the data export schedules (name, export type, enabled flag), newest first. Use for \"Which data export schedules are","description":"List the data export schedules (name, export type, enabled flag), newest first. Use for \"Which data export schedules are set up in my Confident AI project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many schedules per page (1 to 100).","title":"Page Size"},"export_type":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only schedules with this export type, for example TRACES or CONVERSATIONS.","title":"Export Type"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for only running schedules, false for only paused ones (leave empty for both).","title":"Enabled"}},"title":"list_export_schedulesArguments","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_forwarding_connectors":{"post":{"operationId":"list_forwarding_connectors","summary":"List the trace forwarding connectors (name, OTLP collector endpoint, enabled flag), newest first. Use for \"Where does my","description":"List the trace forwarding connectors (name, OTLP collector endpoint, enabled flag), newest first. Use for \"Where does my Confident AI project forward traces\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many connectors per page (1 to 100).","title":"Page Size"}},"title":"list_forwarding_connectorsArguments","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_mcp_servers":{"post":{"operationId":"list_mcp_servers","summary":"List the MCP servers registered in the project (name, description, transport, URL, connected flag; credentials are not r","description":"List the MCP servers registered in the project (name, description, transport, URL, connected flag; credentials are not returned), ordered by name. Use for \"Which MCP servers are registered in my Confident AI project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many servers per page (1 to 100).","title":"Page Size"}},"title":"list_mcp_serversArguments","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_ai_connections":{"post":{"operationId":"list_ai_connections","summary":"List the AI connections (application endpoints Confident AI calls) with name, endpoint and whether the last check succee","description":"List the AI connections (application endpoints Confident AI calls) with name, endpoint and whether the last check succeeded, ordered by name. Use for \"Which AI connections does my Confident AI project have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many connections per page (1 to 100).","title":"Page Size"}},"title":"list_ai_connectionsArguments","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}}}}