{"openapi":"3.1.0","info":{"title":"Dremio Cloud (BYOK) API","version":"0.1.0","description":"Dremio Cloud (BYOK) lets an AI assistant read your own Dremio Cloud data through the Dremio Cloud API with a key you supply (personal access token). Read-only: 9 tools (list_projects, get_project, list_engines, get_engine, list_catalog_roots, get_catalog_object, get_job, list_reflections, list_scripts). The BYOK key travels with each request, is used for that one call only and is never stored,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-dremio-cloud.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-dremio-cloud/docs"},"termsOfService":"https://connectorbay.com/byok-dremio-cloud/terms"},"servers":[{"url":"https://byok-dremio-cloud.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-dremio-cloud/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 Dremio Cloud projects of the organization with id, name, type, cloud region, state and engine count. Storage cr","description":"List the Dremio Cloud projects of the organization with id, name, type, cloud region, state and engine count. Storage credentials are not returned. Use for \"Which Dremio Cloud projects do we have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"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_project":{"post":{"operationId":"get_project","summary":"Get one project: name, type, region, state, number of engines and timestamps. Use for \"What state is Dremio project defa","description":"Get one project: name, type, region, state, number of engines and timestamps. Use for \"What state is Dremio project default-project in\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Project id (UUID).","maxLength":200,"title":"Id","type":"string"}},"required":["id"],"title":"get_projectArguments","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_engines":{"post":{"operationId":"list_engines","summary":"List the compute engines of a project with size, state, replica counts, auto-stop delay, limits and last query time. Use","description":"List the compute engines of a project with size, state, replica counts, auto-stop delay, limits and last query time. Use for \"Which Dremio engines are running and how big are they\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Dremio Cloud project id (UUID); list_projects returns it.","maxLength":200,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"list_enginesArguments","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_engine":{"post":{"operationId":"get_engine","summary":"Get one engine: size, state, replicas, queue and runtime limits. Use for \"How is the Dremio engine firstEngine configure","description":"Get one engine: size, state, replicas, queue and runtime limits. Use for \"How is the Dremio engine firstEngine configured\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Dremio Cloud project id (UUID); list_projects returns it.","maxLength":200,"title":"Project Id","type":"string"},"id":{"description":"Engine id (UUID) from list_engines.","maxLength":200,"title":"Id","type":"string"}},"required":["project_id","id"],"title":"get_engineArguments","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_catalog_roots":{"post":{"operationId":"list_catalog_roots","summary":"List the top-level objects of a project's catalog (sources and spaces) with id, path, container type and creation time. ","description":"List the top-level objects of a project's catalog (sources and spaces) with id, path, container type and creation time. Use for \"What sources and spaces are in my Dremio catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Dremio Cloud project id (UUID); list_projects returns it.","maxLength":200,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"list_catalog_rootsArguments","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_catalog_object":{"post":{"operationId":"get_catalog_object","summary":"Get a catalog object (source, space, folder, table or view) by id: type, path, owner, column names and types for dataset","description":"Get a catalog object (source, space, folder, table or view) by id: type, path, owner, column names and types for datasets, and child objects for folders. Source connection settings are not returned. Use for \"What columns does the Dremio table with id c9c11d32-0576-4200-5a5b-8c7229cb3d72 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Dremio Cloud project id (UUID); list_projects returns it.","maxLength":200,"title":"Project Id","type":"string"},"id":{"description":"Catalog object id (UUID), from list_catalog_roots or a folder's children.","maxLength":200,"title":"Id","type":"string"},"max_children":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"For folders and sources: how many child objects to return per page.","title":"Max Children"},"page_token":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Token for the next page of children (use together with max_children).","title":"Page Token"}},"required":["project_id","id"],"title":"get_catalog_objectArguments","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_job":{"post":{"operationId":"get_job","summary":"Get the status of a SQL job by id: state, row count, error message, start and end time, query type and queue. Use for \"D","description":"Get the status of a SQL job by id: state, row count, error message, start and end time, query type and queue. Use for \"Did Dremio job 22feee74-875a-d24f-ef2f-1fb33cc51200 finish\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Dremio Cloud project id (UUID); list_projects returns it.","maxLength":200,"title":"Project Id","type":"string"},"id":{"description":"Job id (UUID) returned when the job was submitted.","maxLength":200,"title":"Id","type":"string"}},"required":["project_id","id"],"title":"get_jobArguments","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_reflections":{"post":{"operationId":"list_reflections","summary":"List a project's reflections (query accelerators) with type, dataset, size, enabled flag and refresh status. Use for \"Wh","description":"List a project's reflections (query accelerators) with type, dataset, size, enabled flag and refresh status. Use for \"Which Dremio reflections are failing to refresh\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Dremio Cloud project id (UUID); list_projects returns it.","maxLength":200,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"list_reflectionsArguments","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_scripts":{"post":{"operationId":"list_scripts","summary":"List saved SQL scripts of a project with name, context, owner and timestamps. The SQL text is not returned. Use for \"Whi","description":"List saved SQL scripts of a project with name, context, owner and timestamps. The SQL text is not returned. Use for \"Which saved SQL scripts exist in my Dremio project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Dremio Cloud project id (UUID); list_projects returns it.","maxLength":200,"title":"Project Id","type":"string"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only scripts whose name contains this text.","title":"Search"},"max_results":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many scripts to return (1 to 100, default 25).","title":"Max Results"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many scripts to skip.","title":"Offset"}},"required":["project_id"],"title":"list_scriptsArguments","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}}}}