{"openapi":"3.1.0","info":{"title":"Paperspace (BYOK) API","version":"0.1.0","description":"Paperspace (BYOK) lets an AI assistant read your own Paperspace data through the Paperspace API with a key you supply (Paperspace API key). Read-only: 12 tools (get_session, list_machines, get_machine, list_machine_events, get_machine_availability, list_deployments, get_deployment, list_deployment_runs, list_projects, list_datasets, list_models, list_snapshots). 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-paperspace.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-paperspace/docs"},"termsOfService":"https://connectorbay.com/byok-paperspace/terms"},"servers":[{"url":"https://byok-paperspace.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-paperspace/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_session":{"post":{"operationId":"get_session","summary":"Show the team and user the key belongs to: team id, namespace and machine limit, plus the user's id and name. Use for \"W","description":"Show the team and user the key belongs to: team id, namespace and machine limit, plus the user's id and name. Use for \"Which Paperspace team does my API key belong to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_sessionArguments","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_machines":{"post":{"operationId":"list_machines","summary":"List the team's machines with state, machine type, region, CPU, RAM in bytes, usage rate and storage. Page with the afte","description":"List the team's machines with state, machine type, region, CPU, RAM in bytes, usage rate and storage. Page with the after cursor. Use for \"Which Paperspace machines do I have and are they running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from a previous answer's nextPage field to fetch the next page.","title":"After"},"limit":{"anyOf":[{"maximum":120,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page (1 to 120).","title":"Limit"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Order"},"order_by":{"anyOf":[{"enum":["dtCreated","name","state"],"type":"string"},{"type":"null"}],"default":"dtCreated","description":"Sort field.","title":"Order By"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only machines with this name.","title":"Name"},"machine_type":{"anyOf":[{"maxLength":50,"type":"string"},{"type":"null"}],"default":null,"description":"Only machines of this type, for example 'C5'.","title":"Machine Type"},"region":{"anyOf":[{"enum":["ny2","ca1","ams1"],"type":"string"},{"type":"null"}],"default":null,"description":"Only machines in this region.","title":"Region"}},"title":"list_machinesArguments","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_machine":{"post":{"operationId":"get_machine","summary":"Get one machine: state, type, region, CPU, RAM, accelerators, storage, auto-shutdown and snapshot settings, IP addresses","description":"Get one machine: state, type, region, CPU, RAM, accelerators, storage, auto-shutdown and snapshot settings, IP addresses and usage rate. Use for \"What is the state of my Paperspace machine psabc123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"machine_id":{"description":"Machine id from list_machines.","maxLength":200,"title":"Machine Id","type":"string"}},"required":["machine_id"],"title":"get_machineArguments","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_machine_events":{"post":{"operationId":"list_machine_events","summary":"List lifecycle events (create, start, stop and so on) of machines with state, error text and timestamps. Use for \"What h","description":"List lifecycle events (create, start, stop and so on) of machines with state, error text and timestamps. Use for \"What happened to my Paperspace machine recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from a previous answer's nextPage field to fetch the next page.","title":"After"},"limit":{"anyOf":[{"maximum":120,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page (1 to 120).","title":"Limit"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Order"},"machine_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only events of this machine id.","title":"Machine Id"}},"title":"list_machine_eventsArguments","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_machine_availability":{"post":{"operationId":"get_machine_availability","summary":"Check whether a machine type is currently available in a region. Use for \"Is a C5 machine available in Paperspace region","description":"Check whether a machine type is currently available in a region. Use for \"Is a C5 machine available in Paperspace region ny2 right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"machine_type":{"description":"Machine type name, for example 'C5' or 'A100'.","maxLength":50,"title":"Machine Type","type":"string"},"region":{"description":"Region: ny2, ca1 or ams1.","enum":["ny2","ca1","ams1"],"title":"Region","type":"string"}},"required":["machine_type","region"],"title":"get_machine_availabilityArguments","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_deployments":{"post":{"operationId":"list_deployments","summary":"List the team's deployments with name, endpoint, project and creation time. Access keys are not returned. Use for \"Which","description":"List the team's deployments with name, endpoint, project and creation time. Access keys are not returned. Use for \"Which deployments exist on my Paperspace account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from a previous answer's nextPage field to fetch the next page.","title":"After"},"limit":{"anyOf":[{"maximum":120,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page (1 to 120).","title":"Limit"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Order"}},"title":"list_deploymentsArguments","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_deployment":{"post":{"operationId":"get_deployment","summary":"Get one deployment with its endpoint and latest spec: image, region, port, enabled flag and health time. Access keys are","description":"Get one deployment with its endpoint and latest spec: image, region, port, enabled flag and health time. Access keys are not returned. Use for \"What image does my Paperspace deployment run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_id":{"description":"Deployment id (UUID) from list_deployments.","maxLength":200,"title":"Deployment Id","type":"string"}},"required":["deployment_id"],"title":"get_deploymentArguments","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_deployment_runs":{"post":{"operationId":"list_deployment_runs","summary":"List the active runs of a deployment with replica, ready replica and available replica counts. Use for \"How many replica","description":"List the active runs of a deployment with replica, ready replica and available replica counts. Use for \"How many replicas of my Paperspace deployment are ready\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_id":{"description":"Deployment id (UUID) from list_deployments.","maxLength":200,"title":"Deployment Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Latest N runs to return (default 10).","title":"Limit"}},"required":["deployment_id"],"title":"list_deployment_runsArguments","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_projects":{"post":{"operationId":"list_projects","summary":"List the team's projects with name, linked repository and creation time. Use for \"What projects do I have on Paperspace\"","description":"List the team's projects with name, linked repository and creation time. Use for \"What projects do I have on Paperspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from a previous answer's nextPage field to fetch the next page.","title":"After"},"limit":{"anyOf":[{"maximum":120,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page (1 to 120).","title":"Limit"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Order"}},"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/list_datasets":{"post":{"operationId":"list_datasets","summary":"List datasets with name, description, visibility and modification time. Use for \"Which datasets are on my Paperspace acc","description":"List datasets with name, description, visibility and modification time. Use for \"Which datasets are on my Paperspace account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from a previous answer's nextPage field to fetch the next page.","title":"After"},"limit":{"anyOf":[{"maximum":120,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page (1 to 120).","title":"Limit"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Order"},"team_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only datasets of this team id.","title":"Team Id"}},"title":"list_datasetsArguments","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_models":{"post":{"operationId":"list_models","summary":"List registered models with name, description, project and visibility. Use for \"What models are registered in Paperspace","description":"List registered models with name, description, project and visibility. Use for \"What models are registered in Paperspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from a previous answer's nextPage field to fetch the next page.","title":"After"},"limit":{"anyOf":[{"maximum":120,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page (1 to 120).","title":"Limit"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Order"},"project_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only models of this project id.","title":"Project Id"}},"title":"list_modelsArguments","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 machine snapshots with name, machine id and whether the snapshot was automatic. Use for \"What snapshots exist for m","description":"List machine snapshots with name, machine id and whether the snapshot was automatic. Use for \"What snapshots exist for my Paperspace machines\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from a previous answer's nextPage field to fetch the next page.","title":"After"},"limit":{"anyOf":[{"maximum":120,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page (1 to 120).","title":"Limit"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Order"},"machine_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only snapshots of this machine id.","title":"Machine Id"}},"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}}}}