> ## Documentation Index > Fetch the complete documentation index at: https://docs.aireserve.com/llms.txt > Use this file to discover all available pages before exploring further. # Get volume > State, size, billing status, and any active delinquency episode. Requires compute `read` access. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/gpu/volumes/{volumeId} openapi: 3.0.3 info: title: AI Reserve Gateway API description: >- The AI Reserve API surface — OpenAI-compatible chat completions, Anthropic-compatible messages, Bedrock Converse, images, video, files, text-to-speech, realtime voice sessions, and provider-hidden GPU infrastructure — all behind one endpoint and one API key. version: 1.0.0 servers: - url: https://api.aireserve.com security: - bearerAuth: [] tags: - name: Customers description: >- Per-end-customer usage, cost, and billable amounts for organizations that tag requests with their own customers. - name: GPU Infrastructure description: >- Provision and manage provider-hidden GPU instances. The recommended Instances API accepts workload requirements and an hourly price ceiling; AI Reserve handles provider placement internally. Every mutation is asynchronous and returns an operation to poll. - name: Customer keys description: >- Mint, list, and revoke API keys pinned to your own end customers (and their organizations), so spend splits per customer without per-request tagging. paths: /v1/gpu/volumes/{volumeId}: get: tags: - GPU Infrastructure summary: Get volume description: >- State, size, billing status, and any active delinquency episode. Requires compute `read` access. operationId: getVolume parameters: - name: volumeId in: path required: true schema: format: uuid type: string responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string status: type: string enum: - requested - provisioning - ready - reconciling - deleting - deleted - failed region: nullable: true description: >- Normalized region. Instances that mount this volume are placed here. type: string dataCenterId: type: string description: >- Legacy provider location identifier for the Pods API. Prefer `region`. datacenter: type: string description: Alias for `dataCenterId`. sizeGb: type: integer minimum: -9007199254740991 maximum: 9007199254740991 attachedPodId: nullable: true type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ attachedInstanceId: nullable: true description: Alias for `attachedPodId`. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ hourlyRateUsd: type: string pattern: ^\d+(?:\.\d{1,6})?$ description: Current total hourly storage charge. rateUsdPerHour: type: string pattern: ^\d+(?:\.\d{1,6})?$ description: Alias for `hourlyRateUsd`. billsUntilDeleted: type: boolean enum: - true survivesStop: type: boolean enum: - true survivesTerminate: type: boolean enum: - true multiAttach: type: boolean enum: - false paidThroughAt: nullable: true type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ delinquency: description: >- Active delinquency episode. Present on `GET /v1/gpu/volumes/{id}` only. nullable: true type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ status: type: string unpaidAmountUsd: type: string pattern: ^\d+(?:\.\d{1,6})?$ description: USD amount as a six-decimal string. Never a float. graceEndsAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ required: - id - status - unpaidAmountUsd - graceEndsAt additionalProperties: false attachedClusterId: nullable: true description: Cluster currently mounting this volume. type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ required: - id - name - status - region - dataCenterId - datacenter - sizeGb - attachedPodId - attachedInstanceId - attachedClusterId - hourlyRateUsd - rateUsdPerHour - billsUntilDeleted - survivesStop - survivesTerminate - multiAttach - paidThroughAt - createdAt additionalProperties: false description: >- A network volume. Storage bills hourly regardless of pod state until deleted. '400': description: Invalid request, missing Idempotency-Key, or schema violation. content: application/json: schema: $ref: '#/components/schemas/ComputeError' '401': description: Missing or invalid API key. content: application/json: schema: $ref: '#/components/schemas/ComputeError' '403': description: Key lacks the required compute access (`read` or `manage`). content: application/json: schema: $ref: '#/components/schemas/ComputeError' '404': description: Resource not found or owned by another organization. content: application/json: schema: $ref: '#/components/schemas/ComputeError' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: ComputeError: type: object properties: error: type: object properties: message: type: string type: type: string enum: - invalid_request_error - authentication_error - permission_error - server_error param: nullable: true type: string code: type: string description: >- Machine-readable Compute error code, e.g. `quote_expired`, `price_changed`, `operation_conflict`, `no_capacity`, `volume_in_use`, `insufficient_funds`, `compute_access_required`, `not_found`. details: description: >- Machine-readable context for some codes. For `no_capacity` see `ComputeNoCapacityDetails`. type: object additionalProperties: {} required: - message - type - param - code additionalProperties: false required: - error additionalProperties: false description: OpenAI-shaped error envelope returned on every 4xx/5xx. securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your AI Reserve API key (aireserve_api_…) from the API Keys page in the portal (https://portal.aireserve.com/keys). apiKeyAuth: type: apiKey in: header name: x-api-key description: The same API key sent as an `x-api-key` header. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.