{"openapi":"3.1.0","info":{"title":"Runloop (BYOK) API","version":"0.1.0","description":"Runloop (BYOK) lets an AI assistant read your own Runloop data through the Runloop API with a key you supply (Runloop API key). Read-only: 10 tools (get_account, list_devboxes, get_devbox, get_devbox_usage, list_blueprints, list_public_blueprints, list_snapshots, list_agents, list_network_policies, list_secret_names). The BYOK key travels with each request, is used for that one call only and is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-runloop.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-runloop/docs"},"termsOfService":"https://connectorbay.com/byok-runloop/terms"},"servers":[{"url":"https://byok-runloop.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-runloop/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/get_account":{"post":{"operationId":"get_account","summary":"Show the Runloop account the key belongs to: id, name, plan tier, status and creation time. Billing identifiers are not ","description":"Show the Runloop account the key belongs to: id, name, plan tier, status and creation time. Billing identifiers are not requested. Use for \"Which Runloop account and plan is this key for\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_accountArguments","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_devboxes":{"post":{"operationId":"list_devboxes","summary":"List sandbox devboxes with status, name, blueprint or snapshot they started from, creation time and metadata; filter by ","description":"List sandbox devboxes with status, name, blueprint or snapshot they started from, creation time and metadata; filter by status. Use for \"Which Runloop devboxes are running right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["scheduled","queued","provisioning","initializing","running","suspending","suspended","resuming","failure","shutdown"],"type":"string"},{"type":"null"}],"default":null,"description":"Only devboxes in this state.","title":"Status"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many devboxes to return (1 to 100; the API itself allows more).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last devboxe of the previous page, to load the next page.","title":"Starting After"}},"title":"list_devboxesArguments","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_devbox":{"post":{"operationId":"get_devbox","summary":"Get one devbox: status, times (Unix milliseconds), origin blueprint or snapshot, metadata and launch size settings. Use ","description":"Get one devbox: status, times (Unix milliseconds), origin blueprint or snapshot, metadata and launch size settings. Use for \"What is the state of Runloop devbox dbx_abc\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Devbox id, from list_devboxes.","maxLength":200,"title":"Id","type":"string"}},"required":["id"],"title":"get_devboxArguments","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_devbox_usage":{"post":{"operationId":"get_devbox_usage","summary":"Show the resource usage of one devbox: active and elapsed seconds, vCPU seconds, memory GB seconds and disk GB seconds. ","description":"Show the resource usage of one devbox: active and elapsed seconds, vCPU seconds, memory GB seconds and disk GB seconds. Use for \"How much compute did Runloop devbox dbx_abc use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Devbox id, from list_devboxes.","maxLength":200,"title":"Id","type":"string"}},"required":["id"],"title":"get_devbox_usageArguments","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_blueprints":{"post":{"operationId":"list_blueprints","summary":"List your devbox blueprints (container image templates) with name, build status, state and creation time; filter by name","description":"List your devbox blueprints (container image templates) with name, build status, state and creation time; filter by name or status. Use for \"Which Runloop blueprints have I built\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only blueprints whose name matches this text.","title":"Name"},"status":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only blueprints with this build status: queued, provisioning, building, failed or build_complete.","title":"Status"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many blueprints to return (1 to 100; the API itself allows more).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last blueprint of the previous page, to load the next page.","title":"Starting After"}},"title":"list_blueprintsArguments","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_public_blueprints":{"post":{"operationId":"list_public_blueprints","summary":"List the public blueprints that every Runloop user can start devboxes from, with name, build status and creation time. U","description":"List the public blueprints that every Runloop user can start devboxes from, with name, build status and creation time. Use for \"Which public Runloop blueprints are available\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only blueprints whose name matches this text.","title":"Name"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many blueprints to return (1 to 100; the API itself allows more).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last blueprint of the previous page, to load the next page.","title":"Starting After"}},"title":"list_public_blueprintsArguments","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_snapshots":{"post":{"operationId":"list_snapshots","summary":"List disk snapshots of devboxes with name, source devbox or blueprint, commit message, size and creation time. Use for \"","description":"List disk snapshots of devboxes with name, source devbox or blueprint, commit message, size and creation time. Use for \"Which disk snapshots do I have in Runloop\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"devbox_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only snapshots of this devbox.","title":"Devbox Id"},"source_blueprint_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only snapshots whose source is this blueprint.","title":"Source Blueprint Id"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many snapshots to return (1 to 100; the API itself allows more).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last snapshot of the previous page, to load the next page.","title":"Starting After"}},"title":"list_snapshotsArguments","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_agents":{"post":{"operationId":"list_agents","summary":"List registered agent definitions with name, version, public flag and creation time. Use for \"Which agents are registere","description":"List registered agent definitions with name, version, public flag and creation time. Use for \"Which agents are registered in my Runloop account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only agents whose id or name matches this text.","title":"Search"},"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only agents whose name contains this text.","title":"Name"},"is_public":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list only public agents, false for private ones.","title":"Is Public"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many agents to return (1 to 100; the API itself allows more).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last agent of the previous page, to load the next page.","title":"Starting After"}},"title":"list_agentsArguments","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_network_policies":{"post":{"operationId":"list_network_policies","summary":"List devbox network policies with name, description and the egress rules (allow all, hostnames, CIDRs, gateways). Use fo","description":"List devbox network policies with name, description and the egress rules (allow all, hostnames, CIDRs, gateways). Use for \"Which network policies limit my Runloop devboxes\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only policies whose id or name matches this text.","title":"Search"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many network policies to return (1 to 100; the API itself allows more).","title":"Limit"},"starting_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last network policie of the previous page, to load the next page.","title":"Starting After"}},"title":"list_network_policiesArguments","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_secret_names":{"post":{"operationId":"list_secret_names","summary":"List the names of the account secrets with ids and times. The API never returns secret values. Use for \"Which secrets ar","description":"List the names of the account secrets with ids and times. The API never returns secret values. Use for \"Which secrets are stored in my Runloop account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many secrets to return (1 to 100).","title":"Limit"}},"title":"list_secret_namesArguments","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}}}}