{"openapi":"3.0.0","info":{"description":"Beam API connector - serverless GPU compute platform for deploying your own AI apps and endpoints. REST gateway API on app.beam.cloud (Tasks, Deployments, Pods/Sandboxes, Machines, Stubs, Tokens, Workers, Pools). Bearer token auth. No hosted model catalog - inference runs your deployed code.","version":"v1"},"servers":[{"description":"Beam API connector - serverless GPU compute platform for deploying your own AI apps and endpoints. REST gateway API on app.beam.cloud (Tasks, Deployments, Pods/Sandboxes, Machines, Stubs, Tokens, Workers, Pools). Bearer token auth. No hosted model catalog - inference runs your deployed code.","url":"https://api.apirails.com/beam"}],"paths":{"/auth/authorize":{"post":{"tags":["Auth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/auth/authorize"},"summary":"Authorize","description":"Auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/auth/sign":{"post":{"tags":["Auth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/auth/sign"},"summary":"Sign payload","description":"Sign payload","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"payload":{"type":"string","description":"payload"}}},"example":{"payload":""}}}}}},"/containers":{"get":{"tags":["Containers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gatewayservice/get-containers.md","api_endpoint":"https://app.beam.cloud/api/v1/gateway/containers"},"summary":"List containers","description":"List containers","security":[{"bearerAuth":[]}]}},"/containers/{containerId}/stop":{"post":{"tags":["Containers"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gatewayservice/post-containers-stop.md","api_endpoint":"https://app.beam.cloud/api/v1/gateway/containers/{containerId}/stop"},"summary":"Stop container","description":"Stop container","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/deployments":{"get":{"tags":["Deployments"],"parameters":[{"name":"filters","in":"query","description":"Filter expression for the list query (e.g. by status or name)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/deployments"},"summary":"List deployments","description":"Deployments","security":[{"bearerAuth":[]}]}},"/deployments/{id}":{"delete":{"tags":["Deployments"],"parameters":[{"name":"id","in":"path","description":"ID of the deployment","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/deployments/{id}"},"summary":"Delete deployment","description":"Delete deployment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/deployments/{id}/scale":{"post":{"tags":["Deployments"],"parameters":[{"name":"id","in":"path","description":"ID of the deployment","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/deployments/{id}/scale"},"summary":"Scale deployment","description":"Scale deployment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"containers":{"type":"number","description":"Number of containers to scale the deployment to"}}},"example":{"containers":""}}}}}},"/deployments/{id}/start":{"post":{"tags":["Deployments"],"parameters":[{"name":"id","in":"path","description":"ID of the deployment","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/deployments/{id}/start"},"summary":"Start deployment","description":"Start deployment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/deployments/{id}/stop":{"post":{"tags":["Deployments"],"parameters":[{"name":"id","in":"path","description":"ID of the deployment","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/deployments/{id}/stop"},"summary":"Stop deployment","description":"Stop deployment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/machines":{"get":{"tags":["Machines"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"schema":{"type":"number","example":""}},{"name":"poolName","in":"query","description":"Name of the machine pool to create the machine in","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/machines"},"summary":"List machines","description":"Machines","security":[{"bearerAuth":[]}]},"post":{"tags":["Machines"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/machines"},"summary":"Create machine","description":"Create machine","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"poolName":{"type":"string","description":"Name of the machine pool to create the machine in"}}},"example":{"poolName":""}}}}}},"/machines/{machineId}":{"delete":{"tags":["Machines"],"parameters":[{"name":"machineId","in":"path","description":"ID of the machine","required":true,"schema":{"type":"string","example":""}},{"name":"poolName","in":"query","description":"Name of the machine pool to create the machine in","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/machines/{machineId}"},"summary":"Delete machine","description":"Delete machine","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/objects":{"post":{"tags":["Objects"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/objects"},"summary":"Create object","description":"Create object","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"hash":{"type":"string","description":"Hash of the object to fetch"},"objectMetadata":{"type":"object","description":"Metadata describing the object","properties":{"name":{"type":"string","description":"Name of the secret variable"},"size":{"type":"string","description":"Size of the object in bytes"}}},"overwrite":{"type":"boolean","description":"Overwrite the object if it already exists","enum":[true,false]},"size":{"type":"string","description":"Size of the object in bytes"}}},"example":{"hash":"","objectMetadata":{},"overwrite":"","size":""}}}}}},"/objects/{hash}":{"get":{"tags":["Objects"],"parameters":[{"name":"hash","in":"path","description":"Hash of the object to fetch","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/objects/{hash}"},"summary":"Get object","description":"Objects","security":[{"bearerAuth":[]}]}},"/pools":{"get":{"tags":["Pools"],"parameters":[{"name":"filters","in":"query","description":"Filter expression for the list query (e.g. by status or name)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pools"},"summary":"List pools","description":"Pools","security":[{"bearerAuth":[]}]}},"/stubs":{"post":{"tags":["Stubs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/stubs"},"summary":"Create stub","description":"Stubs","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"appName":{"type":"string","description":"appName"},"authorized":{"type":"boolean","description":"Whether the stub requires an authorized (non-public) token to invoke","enum":[true,false]},"autoscaler":{"type":"object","description":"Autoscaling policy for the stub","properties":{"type":{"type":"string","description":"Autoscaler type (e.g. queue_depth)"},"maxContainers":{"type":"number","description":"Maximum number of concurrent containers"},"minContainers":{"type":"number","description":"Minimum number of warm containers"},"tasksPerContainer":{"type":"number","description":"Number of tasks a container handles before recycling"}}},"callbackUrl":{"type":"string","description":"callbackUrl"},"checkpointEnabled":{"type":"boolean","description":"Enable checkpoint/restore support for the stub","enum":[true,false]},"concurrentRequests":{"type":"number","description":"concurrentRequests"},"cpu":{"type":"string","description":"Number of CPU cores requested"},"entrypoint":{"type":"array","description":"entrypoint","items":{"type":"string"}},"env":{"type":"array","description":"Free-form map of environment variables (string values) to set for the command","items":{"type":"string"}},"extra":{"type":"string","description":"extra"},"forceCreate":{"type":"boolean","description":"Force creation even if a stub with the same name exists","enum":[true,false]},"gpu":{"type":"string","description":"GPU count requested"},"gpuCount":{"type":"number","description":"gpuCount"},"handler":{"type":"string","description":"Handler executed per task (bfcl function reference)"},"imageId":{"type":"string","description":"imageId"},"inputs":{"type":"object","description":"Input/output wiring for handler functions","properties":{"fields":{"type":"object","description":"Free-form map of typed fields (name -> type string)"}}},"keepWarmSeconds":{"type":"number","description":"Seconds to keep the container warm after the last task"},"maxPendingTasks":{"type":"number","description":"Maximum pending tasks before backpressure"},"memory":{"type":"string","description":"Memory (MiB) requested"},"name":{"type":"string","description":"Name of the secret variable"},"objectId":{"type":"string","description":"objectId"},"onDeploy":{"type":"string","description":"onDeploy"},"onDeployStubId":{"type":"string","description":"onDeployStubId"},"onStart":{"type":"string","description":"onStart"},"outputs":{"type":"object","description":"Output wiring for handler functions","properties":{"fields":{"type":"object","description":"Free-form map of typed fields (name -> type string)"}}},"ports":{"type":"array","description":"Ports to expose on the container","items":{"type":"number"}},"pricing":{"type":"object","description":"pricing","properties":{"costModel":{"type":"string","description":"Pricing cost model (per_task or per_second)"},"costPerTask":{"type":"number","description":"Cost per task under per_task cost model"},"costPerTaskDurationMs":{"type":"number","description":"Task duration in ms used for per_task pricing"},"maxInFlight":{"type":"string","description":"Maximum in-flight requests for pricing calculations"}}},"pythonVersion":{"type":"string","description":"Python version for the runtime"},"retries":{"type":"number","description":"retries"},"secrets":{"type":"array","description":"Secrets to expose as environment variables in the container","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the secret variable"}}}},"stubType":{"type":"string","description":"stubType"},"taskPolicy":{"type":"object","description":"Task retry/timeout policy","properties":{"maxRetries":{"type":"number","description":"Maximum task retries before failing"},"timeout":{"type":"string","description":"Task timeout in seconds"},"ttl":{"type":"number","description":"Time in seconds a completed task stays queryable"}}},"tcp":{"type":"boolean","description":"tcp","enum":[true,false]},"timeout":{"type":"string","description":"Task timeout in seconds"},"volumes":{"type":"array","description":"Volumes to mount into the container","items":{"type":"object","properties":{"config":{"type":"object","description":"config"},"id":{"type":"string","description":"ID of the deployment"},"mountPath":{"type":"string","description":"mountPath"}}}},"workers":{"type":"number","description":"workers"}}},"example":{"appName":"","authorized":"","autoscaler":{},"callbackUrl":"","checkpointEnabled":"","concurrentRequests":"","cpu":"","entrypoint":[],"env":[],"extra":"","forceCreate":"","gpu":"","gpuCount":"","handler":"","imageId":"","inputs":{},"keepWarmSeconds":"","maxPendingTasks":"","memory":"","name":"","objectId":"","onDeploy":"","onDeployStubId":"","onStart":"","outputs":{},"ports":[],"pricing":{},"pythonVersion":"","retries":"","secrets":[],"stubType":"","taskPolicy":{},"tcp":"","timeout":"","volumes":[],"workers":""}}}}}},"/stubs/deploy":{"post":{"tags":["Stubs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/stubs/deploy"},"summary":"Deploy stub","description":"Deploy stub","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name of the secret variable"},"stubId":{"type":"string","description":"ID of the stub to deploy or run"}}},"example":{"name":"","stubId":""}}}}}},"/stubs/{stubId}/url":{"get":{"tags":["Stubs"],"parameters":[{"name":"stubId","in":"path","description":"ID of the stub to deploy or run","required":true,"schema":{"type":"string","example":""}},{"name":"deploymentId","in":"query","description":"deploymentId","required":false,"schema":{"type":"string","example":""}},{"name":"isShell","in":"query","description":"Return a shell command (true) or a signed URL (false)","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"urlType","in":"query","description":"urlType","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/stubs/{stubId}/url"},"summary":"Get stub URL","description":"Get stub URL","security":[{"bearerAuth":[]}]}},"/tasks":{"get":{"tags":["Tasks"],"parameters":[{"name":"filters","in":"query","description":"Filter expression for the list query (e.g. by status or name)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/tasks"},"summary":"List tasks","description":"List tasks","security":[{"bearerAuth":[]}]}},"/tasks/end":{"post":{"tags":["Tasks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/tasks/end"},"summary":"End task","description":"End task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"containerHostname":{"type":"string","description":"containerHostname"},"containerId":{"type":"string","description":"ID of the container/pod/sandbox"},"keepWarmSeconds":{"type":"number","description":"Seconds to keep the container warm after the last task"},"result":{"type":"string","description":"result"},"taskDuration":{"type":"number","description":"taskDuration"},"taskId":{"type":"string","description":"taskId"},"taskStatus":{"type":"string","description":"taskStatus"}}},"example":{"containerHostname":"","containerId":"","keepWarmSeconds":"","result":"","taskDuration":"","taskId":"","taskStatus":""}}}}}},"/tasks/start":{"post":{"tags":["Tasks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/tasks/start"},"summary":"Start task","description":"Tasks","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"containerId":{"type":"string","description":"ID of the container/pod/sandbox"},"taskId":{"type":"string","description":"taskId"}}},"example":{"containerId":"","taskId":""}}}}}},"/tasks/stop":{"post":{"tags":["Tasks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/tasks/stop"},"summary":"Stop task","description":"Stop task","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"taskIds":{"type":"array","description":"IDs of the tasks to act on","items":{"type":"string"}}}},"example":{"taskIds":[]}}}}}},"/tokens":{"get":{"tags":["Tokens"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/tokens"},"summary":"List tokens","description":"Tokens","security":[{"bearerAuth":[]}]},"post":{"tags":["Tokens"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/tokens"},"summary":"Create token","description":"Create token","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/tokens/{tokenId}":{"delete":{"tags":["Tokens"],"parameters":[{"name":"tokenId","in":"path","description":"ID of the token","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/tokens/{tokenId}"},"summary":"Delete token","description":"Delete token","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/tokens/{tokenId}/toggle":{"post":{"tags":["Tokens"],"parameters":[{"name":"tokenId","in":"path","description":"ID of the token","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/tokens/{tokenId}/toggle"},"summary":"Toggle token","description":"Toggle token","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/workers":{"get":{"tags":["Workers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/workers"},"summary":"List workers","description":"Workers","security":[{"bearerAuth":[]}]}},"/workers/{workerId}/cordon":{"post":{"tags":["Workers"],"parameters":[{"name":"workerId","in":"path","description":"ID of the worker","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/workers/{workerId}/cordon"},"summary":"Cordon worker","description":"Cordon worker","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/workers/{workerId}/drain":{"post":{"tags":["Workers"],"parameters":[{"name":"workerId","in":"path","description":"ID of the worker","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/workers/{workerId}/drain"},"summary":"Drain worker","description":"Drain worker","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/workers/{workerId}/uncordon":{"post":{"tags":["Workers"],"parameters":[{"name":"workerId","in":"path","description":"ID of the worker","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/workers/{workerId}/uncordon"},"summary":"Uncordon worker","description":"Uncordon worker","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/workspace/config":{"get":{"tags":["Workspace"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/workspace/config"},"summary":"Get workspace config","description":"Workspace","security":[{"bearerAuth":[]}]}},"/pods":{"post":{"tags":["Pods"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/podservice/post-pods.md","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods"},"summary":"Create pod","description":"Create pod","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"checkpointId":{"type":"string","description":"ID of the pod checkpoint to restore from (provide exactly one of stubId or checkpointId)"},"stubId":{"type":"string","description":"ID of the stub to deploy or run"}}},"example":{"checkpointId":"","stubId":""}}}}}},"/pods/{containerId}/connect":{"post":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/connect"},"summary":"Connect to pod","description":"Connect to pod","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/pods/{containerId}/directories":{"post":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/directories"},"summary":"Create pod directory","description":"Create pod directory","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"containerPath":{"type":"string","description":"Absolute path inside the container filesystem"},"mode":{"type":"number","description":"POSIX file mode bits for the created directory/file (e.g. 493 for 0755)"}}},"example":{"containerPath":"","mode":""}}}}}},"/pods/{containerId}/directories/{containerPath}":{"delete":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}},{"name":"containerPath","in":"path","description":"Absolute path inside the container filesystem","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/directories/{containerPath}"},"summary":"Delete pod directory","description":"Delete pod directory","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/pods/{containerId}/exec":{"post":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/exec"},"summary":"Execute command in pod","description":"Execute command in pod","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"command":{"type":"string","description":"Shell command to execute inside the container"},"cwd":{"type":"string","description":"Working directory in which to run the command"},"env":{"type":"object","description":"Free-form map of environment variables (string values) to set for the command"}}},"example":{"command":"","cwd":"","env":{}}}}}}},"/pods/{containerId}/files":{"get":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}},{"name":"containerPath","in":"query","description":"Absolute path inside the container filesystem","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/files"},"summary":"List pod files","description":"List pod files","security":[{"bearerAuth":[]}]}},"/pods/{containerId}/files/download/{containerPath}":{"get":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}},{"name":"containerPath","in":"path","description":"Absolute path inside the container filesystem","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/files/download/{containerPath}"},"summary":"Download pod file","description":"Download pod file","security":[{"bearerAuth":[]}]}},"/pods/{containerId}/files/find":{"post":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/files/find"},"summary":"Find files in pod","description":"Find files in pod","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"containerPath":{"type":"string","description":"Absolute path inside the container filesystem"},"pattern":{"type":"string","description":"Search pattern (regex) to match inside the files"}}},"example":{"containerPath":"","pattern":""}}}}}},"/pods/{containerId}/files/replace":{"post":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/files/replace"},"summary":"Replace text in pod files","description":"Replace text in pod files","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"containerPath":{"type":"string","description":"Absolute path inside the container filesystem"},"newString":{"type":"string","description":"Replacement string substituted for each match of pattern"},"pattern":{"type":"string","description":"Search pattern (regex) to match inside the files"}}},"example":{"containerPath":"","newString":"","pattern":""}}}}}},"/pods/{containerId}/files/stat":{"get":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}},{"name":"containerPath","in":"query","description":"Absolute path inside the container filesystem","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/files/stat"},"summary":"Get pod file stats","description":"Get pod file stats","security":[{"bearerAuth":[]}]}},"/pods/{containerId}/files/upload":{"post":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/files/upload"},"summary":"Upload file to pod","description":"Upload file to pod","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"containerPath":{"type":"string","description":"Absolute path inside the container filesystem"},"data":{"type":"string","description":"File contents encoded as a base64 string"},"mode":{"type":"number","description":"POSIX file mode bits for the created directory/file (e.g. 493 for 0755)"}}},"example":{"containerPath":"","data":"","mode":""}}}}}},"/pods/{containerId}/files/{containerPath}":{"delete":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}},{"name":"containerPath","in":"path","description":"Absolute path inside the container filesystem","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/files/{containerPath}"},"summary":"Delete pod file","description":"Delete pod file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/pods/{containerId}/kill":{"post":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/kill"},"summary":"Kill pod","description":"Kill pod","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pid":{"type":"number","description":"pid"}}},"example":{"pid":""}}}}}},"/pods/{containerId}/ports/expose":{"post":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/ports/expose"},"summary":"Expose pod port","description":"Expose pod port","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"port":{"type":"number","description":"Container port number to expose"},"stubId":{"type":"string","description":"ID of the stub to deploy or run"}}},"example":{"port":"","stubId":""}}}}}},"/pods/{containerId}/processes":{"get":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/processes"},"summary":"List pod processes","description":"List pod processes","security":[{"bearerAuth":[]}]}},"/pods/{containerId}/status":{"get":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}},{"name":"pid","in":"query","description":"pid","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/status"},"summary":"Get pod status","description":"Get pod status","security":[{"bearerAuth":[]}]}},"/pods/{containerId}/stderr":{"get":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}},{"name":"pid","in":"query","description":"pid","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/stderr"},"summary":"Get pod stderr","description":"Get pod stderr","security":[{"bearerAuth":[]}]}},"/pods/{containerId}/stdout":{"get":{"tags":["Pods"],"parameters":[{"name":"containerId","in":"path","description":"ID of the container/pod/sandbox","required":true,"schema":{"type":"string","example":""}},{"name":"pid","in":"query","description":"pid","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json","api_endpoint":"https://app.beam.cloud/api/v1/gateway/pods/{containerId}/stdout"},"summary":"Get pod stdout","description":"Get pod stdout","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}