> ## Documentation Index > Fetch the complete documentation index at: https://docs.sfcompute.com/llms.txt > Use this file to discover all available pages before exploring further. # Create pool transfer > > ⚠️ This endpoint is in [public preview](/preview/roadmap). Transfer some or all of one pool into another ## OpenAPI ````yaml /preview/openapi.json post /preview/v2/pool_transfers openapi: 3.1.0 info: title: sfc-api description: >- Public preview API - subject to change. See https://docs.sfcompute.com/preview/roadmap for details. version: 0.1.0 servers: - url: https://api.sfcompute.com security: - bearer_auth: [] tags: - name: Account description: The authenticated account and logged-in user. - name: Pools description: A bucket of owned compute balance over time. - name: Orders description: >- Place orders targeting a capacity to increase your reserved compute balance during some time period. - name: Instance Templates description: Reusable instance configuration. - name: Images description: Custom machine images for instances. - name: Roles description: TOML-based permission role definitions. - name: Grants description: Bind principals (users or tokens) to roles on a workspace. - name: Tokens description: Workspace-scoped API tokens. - name: Instances description: Spin up instances in a capacity to use your available compute. - name: Instance SKU Catalog description: Browse available instance SKU property definitions. - name: Procurements description: Market automations that maintain capacity by placing buy/sell orders. - name: Deployments description: >- Deployment automations that maintain a fleet of instances, including spot deployments that buy capacity up to a maximum price. - name: Users description: Read-only access to users within the caller's organization. - name: Workspaces description: Resource containers scoped to an account. - name: Permissions description: Inspect what the caller is allowed to do. - name: Billing description: Billing profile, contacts, and auto top-up settings. - name: Orderbook description: >- Read-only orderbook visibility: bid/ask spread, depth, open and filled orders, and historical fills, keyed on hardware requirements + delivery window. - name: Orders description: >- Estimate an order before placing it: filled price, fee, and operational notices. paths: /preview/v2/pool_transfers: post: tags: - Pools summary: Create pool transfer description: |- > ⚠️ This endpoint is in [public preview](/preview/roadmap). Transfer some or all of one pool into another operationId: create_pool_transfer parameters: - name: Idempotency-Key in: header description: Unique key for idempotent transfer creation. required: false schema: type: - string - 'null' requestBody: content: application/json: schema: $ref: '#/components/schemas/v2.CreatePoolTransferRequest' required: true responses: '202': description: Pool transfer accepted. content: application/json: schema: $ref: '#/components/schemas/v2.PoolTransferResponse' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: Forbidden. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '422': description: Validation failed. content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityError' '500': description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/InternalServerError' '503': description: Service temporarily unavailable. Try again later. content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableError' components: schemas: v2.CreatePoolTransferRequest: type: object description: Transfer some or all of one pool into another. required: - from_pool - to_pool - allocation_schedule_delta - instance_sku properties: from_pool: $ref: '#/components/schemas/ResourcePathOrId_PoolId' description: Source pool (must belong to the authenticated caller). to_pool: $ref: '#/components/schemas/ResourcePathOrId_PoolId' description: Destination pool (must belong to the authenticated caller). allocation_schedule_delta: $ref: '#/components/schemas/Schedule' description: >- The transfer's allocation schedule as constant-quantity rectangles. If the final entry does not have `end_at: null`, a zero-quantity unbounded tail is appended automatically. instance_sku: $ref: '#/components/schemas/InstanceSkuId' description: Instance SKU the transfer applies to. v2.PoolTransferResponse: type: object description: >- A transfer of compute from one pool (`from_pool`) to another (`to_pool`). required: - object - id - status - created_at - from_pool - to_pool - instance_sku - allocation_schedule_delta properties: object: type: string description: Discriminator for `/pool_transfers` responses. const: pool_transfer default: pool_transfer readOnly: true id: $ref: '#/components/schemas/PoolTransferId' status: $ref: '#/components/schemas/v2.PoolTransferStatus' created_at: $ref: '#/components/schemas/UnixEpoch' from_pool: $ref: '#/components/schemas/PoolId' to_pool: $ref: '#/components/schemas/PoolId' instance_sku: $ref: '#/components/schemas/InstanceSkuSummary' description: >- Instance SKU the transfer applied to. Carries the SKU's human-readable name when one is registered. rejected_reason: type: - string - 'null' description: Reason a pool transfer was rejected. allocation_schedule_delta: $ref: '#/components/schemas/Schedule' description: >- The transfer's allocation schedule, expanded into constant-quantity rectangles. The final rectangle has `end_at: null` (the unbounded tail); gaps are represented as explicit zero-quantity rectangles. UnauthorizedError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: authentication_error default: authentication_error readOnly: true message: type: string x-speakeasy-error-message: true ForbiddenError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: forbidden default: forbidden readOnly: true message: type: string x-speakeasy-error-message: true NotFoundError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: not_found default: not_found readOnly: true message: type: string x-speakeasy-error-message: true UnprocessableEntityError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: unprocessable_entity default: unprocessable_entity readOnly: true message: type: string x-speakeasy-error-message: true details: type: array items: $ref: '#/components/schemas/ErrorDetail' InternalServerError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: api_error default: api_error readOnly: true message: type: string x-speakeasy-error-message: true ServiceUnavailableError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: service_unavailable default: service_unavailable readOnly: true message: type: string x-speakeasy-error-message: true ResourcePathOrId_PoolId: type: string description: >- A resource path like 'sfc:pool:acme:prod:my-pool' _or_ an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent. examples: - pool_k3R-nX9vLm7Qp2Yw5Jd8F pattern: >- (pool_[0-9a-zA-Z_-]{1,21})|(sfc:pool:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2}) Schedule: type: array items: $ref: '#/components/schemas/ScheduleEntry' description: >- Node count over time, as a list of `[start_at, end_at)` time ranges. Example: 5 nodes from t=0 to t=3600 is `[{"start_at": 0, "end_at": 3600, "node_count": 5}]`. `start_at` and `end_at` must be 60-second aligned, `node_count` must be non-negative. On non-final entries, `end_at` may be omitted (inferred from the next entry's `start_at`); gaps fill with `node_count: 0`. InstanceSkuId: oneOf: - type: string examples: - isku_k3R-nX9vLm7Qp2Yw5Jd8F pattern: isku_[0-9a-zA-Z_-]{1,21} - type: string description: Legacy alias prefix; accepted on read, never emitted on write. pattern: clus_[0-9a-zA-Z_-]{1,21} description: >- Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form. PoolTransferId: oneOf: - type: string examples: - pxfr_k3R-nX9vLm7Qp2Yw5Jd8F pattern: pxfr_[0-9a-zA-Z_-]{1,21} - type: string description: Legacy alias prefix; accepted on read, never emitted on write. pattern: cxfr_[0-9a-zA-Z_-]{1,21} description: >- Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form. v2.PoolTransferStatus: type: string description: Lifecycle status of a pool transfer. enum: - pending - executed - rejected UnixEpoch: type: integer format: int64 description: Unix timestamp. example: 1738972800 PoolId: type: string examples: - pool_k3R-nX9vLm7Qp2Yw5Jd8F pattern: pool_[0-9a-zA-Z_-]{1,21} InstanceSkuSummary: type: object description: >- A summary of an instance SKU - its `id` and human-recognizable `alias` - embedded on resources that reference a SKU. required: - object - id - alias properties: object: type: string const: instance_sku default: instance_sku readOnly: true id: $ref: '#/components/schemas/InstanceSkuId' alias: $ref: '#/components/schemas/Name' ErrorDetail: type: object required: - code - message properties: field: type: - string - 'null' description: The field that caused the error (for validation errors) code: type: string description: Specific error code for this detail message: type: string description: Human-readable error message ScheduleEntry: type: object description: >- A `[start_at, end_at)` time range with a fixed `node_count`. `end_at` is `null` only on the final entry, marking an unbounded tail. required: - start_at - node_count properties: start_at: $ref: '#/components/schemas/UnixEpoch' end_at: oneOf: - type: 'null' - $ref: '#/components/schemas/UnixEpoch' node_count: type: integer format: int32 Name: type: string examples: - my-resource-name maxLength: 255 minLength: 1 pattern: '[a-zA-Z0-9][a-zA-Z0-9._-]{0,254}' securitySchemes: bearer_auth: type: http scheme: bearer bearerFormat: JWT description: >- Create an API token using `sf tokens create` or at https://sfcompute.com/account/api-keys. ````