{"openapi":"3.0.0","info":{"description":"Akash Network decentralized compute marketplace console API — GPU deployments, bids, leases; x-api-key header.","version":null},"servers":[{"description":"Akash Network decentralized compute marketplace console API — GPU deployments, bids, leases; x-api-key header.","url":"https://api.apirails.com/akash"}],"paths":{"/v1/deployments":{"get":{"tags":["Deployments"],"parameters":[{"name":"limit","in":"query","description":"Max records. Default 1000.","required":false,"schema":{"type":"number","example":""}},{"name":"skip","in":"query","description":"Offset. Default 0.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v1/deployments"},"summary":"List deployments","description":"Lists all deployments for the authenticated user, with pagination (response includes a pagination object with total, skip, limit, hasMore).","security":[{"bearerAuth":[]}]},"post":{"tags":["Deployments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v1/deployments"},"summary":"Create deployment","description":"Creates a new deployment from an SDL manifest. Console funds it automatically from your account credits, so the request takes no deposit.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Request envelope for deployment creation.","required":true,"properties":{"runtimeLimitHours":{"type":"number","description":"Close the deployment after this many hours of runtime, counted from lease start. Omit for always-on funding."},"sdl":{"type":"string","description":"Deployment manifest in SDL (YAML) format, as a JSON string. May include a params.tee field (cpu / cpu-gpu) to request Confidential Compute.","required":true}}}}},"example":{"data":{}}}}}}},"/v1/deployments/{dseq}":{"get":{"tags":["Deployments"],"parameters":[{"name":"dseq","in":"path","description":"Deployment sequence ID.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v1/deployments/{dseq}"},"summary":"Get deployment","description":"Retrieves full details for a single deployment by its sequence ID, including active leases.","security":[{"bearerAuth":[]}]},"put":{"tags":["Deployments"],"parameters":[{"name":"dseq","in":"path","description":"Deployment sequence ID to update.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v1/deployments/{dseq}"},"summary":"Update deployment","description":"Updates an active deployment with a revised SDL. Response is the full deployment object.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Request envelope for deployment update.","required":true,"properties":{"sdl":{"type":"string","description":"Revised deployment manifest in SDL (YAML) format, as a JSON string.","required":true}}}}},"example":{"data":{}}}}}},"delete":{"tags":["Deployments"],"parameters":[{"name":"dseq","in":"path","description":"Deployment sequence ID to close.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v1/deployments/{dseq}"},"summary":"Close deployment","description":"Closes a deployment. Whatever it has not yet spent returns to your Console account balance once the chain settles.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/deposit-deployment":{"post":{"tags":["Deployments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v1/deposit-deployment"},"summary":"Deposit into deployment (deprecated)","description":"Deprecated no-op: Console funds every deployment automatically for as long as your account has credits. Kept for existing integrations; will be removed in a future release.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Request envelope for the deprecated deposit call.","required":true,"properties":{"deposit":{"type":"number","description":"Deposit amount in USD (minimum 0.5 per the API reference). Accepted but no longer needed.","required":true},"dseq":{"type":"string","description":"Deployment sequence ID.","required":true}}}}},"example":{"data":{}}}}}}},"/v1/bids":{"get":{"tags":["Bids"],"parameters":[{"name":"dseq","in":"query","description":"Deployment sequence ID returned by create deployment.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v1/bids"},"summary":"List bids","description":"Lists provider bids for a deployment. Poll until bids arrive.","security":[{"bearerAuth":[]}]}},"/v1/leases":{"post":{"tags":["Leases"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v1/leases"},"summary":"Accept bids and ship manifest","description":"Accepts one or more provider bids and ships the manifest in a single call. Response is the full deployment object.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"leases":{"type":"array","description":"One entry per bid to accept.","required":true,"items":{"type":"object","properties":{"dseq":{"type":"string","description":"Deployment sequence ID.","required":true},"gseq":{"type":"number","description":"Group sequence (from bid.id.gseq).","required":true},"oseq":{"type":"number","description":"Order sequence (from bid.id.oseq).","required":true},"provider":{"type":"string","description":"Provider address (from bid.id.provider).","required":true}}}},"manifest":{"type":"string","description":"Manifest blob returned by POST /v1/deployments.","required":true}}},"example":{"leases":[{"dseq":"1234567","gseq":1,"oseq":1,"provider":"akash1provider..."}],"manifest":""}}}}}},"/v2/deployment-settings/{dseq}":{"get":{"tags":["Deployment Settings"],"parameters":[{"name":"dseq","in":"path","description":"Deployment sequence number.","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"query","description":"User id (uuid). Defaults to authenticated user.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v2/deployment-settings/{dseq}"},"summary":"Get deployment settings","description":"Gets the funding settings for a specific deployment, including its runtime limit. Settings are auto-created on first read.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Deployment Settings"],"parameters":[{"name":"dseq","in":"path","description":"Deployment sequence number.","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"query","description":"User id (uuid). Defaults to authenticated user.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v2/deployment-settings/{dseq}"},"summary":"Update deployment settings","description":"Updates an existing settings row. Use this to set, extend, or remove a deployment's runtime limit.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Request envelope for settings update.","properties":{"autoTopUpEnabled":{"type":"boolean","description":"An explicit false is rejected.","enum":[true,false]},"runtimeLimitHours":{"type":"number","description":"New total runtime limit in hours, counted from lease start. Send null to remove the limit and return the deployment to always-on funding. Lowering a limit is not supported."}}}}},"example":{"data":{}}}}}}},"/v2/deployment-settings":{"post":{"tags":["Deployment Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v2/deployment-settings"},"summary":"Create deployment settings","description":"Creates the settings row for a deployment when it does not yet exist. Automatic funding is on by default and cannot be turned off.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Request envelope for settings creation.","required":true,"properties":{"autoTopUpEnabled":{"type":"boolean","description":"Defaults to true when omitted. An explicit false is rejected.","enum":[true,false]},"dseq":{"type":"string","description":"Deployment sequence number.","required":true},"userId":{"type":"string","description":"User id (uuid). Defaults to authenticated user."}}}}},"example":{"data":{}}}}}}},"/v1/providers/{address}":{"get":{"tags":["Providers"],"parameters":[{"name":"address","in":"path","description":"Provider bech32 address on the Akash chain.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v1/providers/{address}"},"summary":"Get provider","description":"Resolves a provider's on-chain attributes, including its hostUri, which is needed to call the provider directly with a lease JWT.","security":[{"bearerAuth":[]}]}},"/v1/create-jwt-token":{"post":{"tags":["JWT Tokens"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://akash.network/docs/api-documentation/console-api/api-reference/","api_endpoint":"https://console-api.akash.network/v1/create-jwt-token"},"summary":"Create lease JWT","description":"Mints a short-lived, lease-scoped JWT for accessing provider endpoints as Authorization: Bearer. Swagger-only / Tier 2 endpoint — may change without notice. No refresh endpoint exists: re-call to extend lifetime.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"Request envelope for token minting.","required":true,"properties":{"leases":{"type":"object","description":"Lease access rules for the token."},"ttl":{"type":"number","description":"Token TTL in seconds (Console UI default: 1800).","required":true}}}}},"example":{"data":{}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}