> ## Documentation Index > Fetch the complete documentation index at: https://docs.hiloop.ai/llms.txt > Use this file to discover all available pages before exploring further. # Post v1volumes > Create a volume in the caller's organization. A duplicate name within the project is a conflict. The volume starts empty (no versions); push content to publish its first version. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v1/volumes openapi: 3.0.3 info: title: '' version: 0.0.1 servers: [] security: - bearerAuth: [] tags: - name: AnnotationSchemaService description: |- Org-scoped annotation-schema registry CRUD. Every RPC scopes to the caller's organization, derived from their credential; a request with no org scope is UNAUTHENTICATED. Registration runs a backward-compatibility check against the latest live version and REJECTS an incompatible change (FAILED_PRECONDITION). These endpoints are what the generated OpenAPI, SDKs, and CLI consume. - name: AnnotationService description: >- Typed annotation surface over the telemetry store: the annotate writes plus the one served annotation read every consumer shares. Organization scoping is enforced from request identity, not from the request body. Ingest of ordinary telemetry lives in TelemetryIngestService (telemetry.proto); the general event read surface lives in TelemetryQueryService (query.proto). - name: FeedbackService description: |- Product-feedback intake. The organization is derived from the caller's credential, never from the request body; a request with no org scope is UNAUTHENTICATED. Any org-scoped caller — a user session, a service key, or a sandbox-scoped credential — may submit feedback. - name: IdentityService description: Identity/health surface for the control-plane API. - name: MetaService description: Unauthenticated discovery surface for client-visible sibling service URLs. - name: ProjectService description: |- Org-scoped project CRUD. Every RPC scopes to the caller's organization, derived from their credential; a request with no org scope is UNAUTHENTICATED. These endpoints are what the generated OpenAPI, SDKs, and CLI consume. - name: RunService description: |- Org-scoped access to runs and their lineage. Every RPC scopes to the caller's organization, derived from their credential; a request with no org scope is UNAUTHENTICATED. These endpoints are what the generated OpenAPI, SDKs, and CLI consume. - name: SandboxService description: |- Org-scoped sandbox runtime API. The organization comes from the caller's credential. Org-scoped human and service credentials may use every route in their organization. A sandbox-scoped, lineage-confined credential may read its own sandbox and snapshot lineage and may exec or snapshot only that sandbox; it may not create, update, or delete sandboxes, delete snapshots, or exec into a sibling sandbox. State and verb rules are closed. Get and list serve every visible state. Failed and terminated rows remain available through GetSandbox for a server retention window, then return 404 not_found. Update to stopped is accepted from ready or running and is idempotent from stopped; update to running wakes stopped and is idempotent from running. A wake racing an in-flight stop waits for stop to win before wake proceeds. Workspace growth is accepted only for a stable durable sandbox and is idempotent for the same target; lifecycle mutation and growth never overlap. An undurable snapshot, including one whose request timed out, fences growth and cannot be deleted because its seal may still publish a late receipt; repeat the same snapshot request (and idempotency key, if supplied) to resolve its outcome. Delete is accepted once for a nonterminal sandbox; a second delete returns 404 not_found. Exec requires running and never wakes implicitly; any other non-quarantined state returns 409 sandbox_not_running. Snapshot is accepted from ready, running, or stopped; other non-quarantined states return 409 sandbox_not_ready. Every mutating verb on a quarantined sandbox returns 409 quarantined. A concurrent snapshot returns 409 snapshot_in_progress. Every error uses the flat {code, message, request_id} envelope. Stable route codes are invalid_argument (400), not_found (404), idempotency_conflict, name_conflict, sandbox_not_running, sandbox_not_ready, quarantined, snapshot_in_progress, snapshot_in_use, and snapshot_not_restorable, workspace_shrink_unsupported, and operation_conflict (409), unsupported_capability (422), quota_exceeded (429; details.quota.metric names the limit — sandboxes.running, sandboxes.total, or sandboxes.workspace_capacity_gib), and unavailable (503). Exec transport failures use spawn_failed or sandbox_stopped and discard any partial output; both mean the command did not run. A command that WAS dispatched but whose outcome could not be read is never an error: it returns 200 with the indeterminate outcome, alongside whatever partial output was collected, as a timeout does. Capability-receipt observation has no route in this version and is explicitly NOTIMPL; it is not inferred from Sandbox fields. - name: SecretService description: |- Org-scoped sandbox-secret management. Every RPC scopes to the caller's organization, derived from their credential; a request with no org scope is UNAUTHENTICATED. Create/revoke/rotate require an owner/admin in the organization; these management RPCs never return the secret value. - name: TelemetryViewService description: >- Typed data-view surface over the telemetry store. Organization scoping is enforced from request identity, not from the request body. A data view's spec is the engine's `DataViewSpec` — a raw `Sql` `SELECT` — re-validated and compiled fresh on every run under the forced-organization safe-SQL gateway. The untrusted raw-SQL escape hatch is a separate `POST /v1/telemetry/sql` endpoint, intentionally kept off this typed wire. - name: UsageService description: Org-scoped product quota reads. - name: VolumeService description: |- Org-scoped volume CRUD. Every RPC scopes to the caller's organization, derived from their credential; a request with no org scope is UNAUTHENTICATED. These endpoints are what the generated OpenAPI, SDKs, and CLI consume. - name: WorkloadService description: |- Org-scoped workload registry management. The organization is derived from the caller's credential; a request with no org scope is UNAUTHENTICATED. Registering and reading workloads is open to any org member. Setting a launch ACL and deleting a workload are operator actions and require an owner or admin in the organization. A sandbox-scoped credential may not register, delete, or manage workloads. paths: /v1/volumes: post: tags: - VolumeService description: >- Create a volume in the caller's organization. A duplicate name within the project is a conflict. The volume starts empty (no versions); push content to publish its first version. operationId: VolumeService_CreateVolume requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVolumeRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateVolumeResponse' '429': $ref: '#/components/responses/RateLimited' default: $ref: '#/components/responses/Error' components: schemas: CreateVolumeRequest: type: object properties: project_id: type: string description: The project the volume belongs to. name: type: string description: >- The volume name — unique within the project (letters, digits, dots, dashes, underscores; at most 100 characters). description: type: string description: >- An optional user-assigned free-text description (at most 4 KiB). Empty leaves the volume undescribed. quota_bytes: type: string description: >- Storage quota in bytes (required). A quota, not an allocation; at most 2 TiB per volume. CreateVolumeResponse: type: object properties: volume: allOf: - $ref: '#/components/schemas/Volume' description: The created volume. Volume: type: object properties: id: type: string description: The volume id. project_id: type: string description: The project the volume belongs to. name: type: string description: >- The volume name — unique within its project. Limited to letters, digits, dots, dashes, and underscores (at most 100 characters). description: type: string description: >- User-assigned free-text description (at most 4 KiB). Empty when unset. quota_bytes: type: string description: >- Storage quota in bytes: the cap on the volume's total committed size. A quota, not an allocation — an empty volume consumes no storage. current_version_digest: type: string description: >- Digest of the volume's current (latest committed) version. Empty until the first push publishes a version. created_by: type: string description: >- Stable id of the principal that created the volume — the API key (or user) that performed the create, recorded server-side. Resolve it to a display name via the principals listing. created_at: type: string description: When the volume was created (RFC 3339). updated_at: type: string description: >- When the volume record was last updated (RFC 3339). Equal to created_at until the first update. used_bytes: type: string description: >- Committed storage in bytes: the total size of the distinct content blobs referenced by the volume's versions. Content is stored deduplicated, so a blob shared by several versions counts once — this is what the volume's committed content occupies, not the sum of its versions' sizes. Zero for a volume with no committed versions. description: A volume record (the subset the API returns). ErrorBody: type: object required: - code - message properties: code: type: string description: Stable machine-readable error code in snake_case. message: type: string description: Human-readable description; clients must not parse it. details: $ref: '#/components/schemas/ErrorDetails' request_id: type: string description: Correlation id present on server faults. ErrorDetails: type: object properties: quota: $ref: '#/components/schemas/QuotaDetails' QuotaDetails: type: object required: - metric - limit properties: metric: type: string limit: type: integer format: uint64 current: type: integer format: uint64 reserved: type: integer format: uint64 retry_after_seconds: type: integer format: uint64 responses: RateLimited: description: A quota or rate-limit rejection. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer format: uint64 content: application/json: schema: $ref: '#/components/schemas/ErrorBody' Error: description: An error using the standard hiloop error envelope. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer format: uint64 content: application/json: schema: $ref: '#/components/schemas/ErrorBody' securitySchemes: bearerAuth: type: http scheme: bearer description: Hiloop API key sent as an HTTP Bearer token. ````