# CoreWeave

> Manage inference deployments, gateways, capacity claims and checkpoint hot-loads.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/coreweave

## Actions

### Cancel checkpoint hot-load

Cancels a hot-load. This operation is not yet implemented and currently returns an Unimplemented error.

**Inputs**

- ID (`id`, text, required): The ID of the hot-load to cancel

**Outputs**

- `data` (object): Response for CancelHotLoad

**Example output**

```json
{
  "data": {
    "hotLoad": {
      "spec": {
        "deploymentId": "example",
        "id": "example",
        "identity": "example",
        "incrementalSnapshotMetadata": {},
        "organizationId": "example",
        "promptCachePolicy": "example",
        "snapshotChain": [],
        "type": "example"
      },
      "status": {
        "canceledAt": "example",
        "conditions": [],
        "createdAt": "example",
        "finishedAt": "example",
        "state": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Create capacity claim

Creates a new CapacityClaim that reserves GPU hardware for inference deployments.

**Inputs**

- ID (`id`, text): The unique identifier of the CapacityClaim, UUID format
- Name (`name`, text): The human readable name of the CapacityClaim
- Resources (`resources`, object, required): The specification for the resources to reserve

**Outputs**

- `data` (object): Response for CreateCapacityClaim

**Example output**

```json
{
  "data": {
    "capacityClaim": {
      "spec": {
        "id": "example",
        "name": "example",
        "organizationId": "example",
        "resources": {}
      },
      "status": {
        "allocatedInstances": 1,
        "conditions": [],
        "createdAt": "example",
        "pendingInstances": 1,
        "status": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Create checkpoint hot-load

Triggers a checkpoint hot-load on a deployment. The operation runs asynchronously, so a successful response means the request was accepted, not that the weights are loaded.

**Inputs**

- Deployment (`deployment_id`, text, required): The ID of the deployment to hot-load
- Hot load (`hot_load_id`, text): The ID to use for the hot-load, which becomes its permanent identifier. Must be a UUID. If omitted, one is generated. Creating a second hot-load with an ID that already exists in the caller's organization fails with ALREADY_EXISTS; an ID that is unavailable for any other…
- Identity (`identity`, text, required): The identity of the target snapshot within the deployment. Must be a single path segment. Multiple hot-load operations may target the same snapshot identity.
- Type (`type`, text, required): The type of the target snapshot. SNAPSHOT_TYPE_FULL carries a complete set of model weights and starts a new snapshot chain. SNAPSHOT_TYPE_INCREMENTAL is a delta against an earlier snapshot and requires incrementalSnapshotMetadata. This field is required; the zero value is…. One of: `SNAPSHOT_TYPE_FULL` (Snapshot type full), `SNAPSHOT_TYPE_INCREMENTAL` (Snapshot type incremental).
- Incremental snapshot metadata (`incremental_snapshot_metadata`, object): Delta metadata, required when type is SNAPSHOT_TYPE_INCREMENTAL
- Prompt cache policy (`prompt_cache_policy`, text): How the prompt cache is handled once the swap completes. PROMPT_CACHE_POLICY_RESET_ALL prevents reuse of any entry computed before the swap. PROMPT_CACHE_POLICY_PRESERVE allows reuse, knowingly stale under the new weights. The policy applies to requests admitted after the…. One of: `PROMPT_CACHE_POLICY_UNSPECIFIED` (Prompt cache policy unspecified), `PROMPT_CACHE_POLICY_RESET_ALL` (Prompt cache policy reset all), `PROMPT_CACHE_POLICY_PRESERVE` (Prompt cache policy preserve).

**Outputs**

- `data` (object): Response for CreateHotLoad

**Example output**

```json
{
  "data": {
    "hotLoad": {
      "spec": {
        "deploymentId": "example",
        "id": "example",
        "identity": "example",
        "incrementalSnapshotMetadata": {},
        "organizationId": "example",
        "promptCachePolicy": "example",
        "snapshotChain": [],
        "type": "example"
      },
      "status": {
        "canceledAt": "example",
        "conditions": [],
        "createdAt": "example",
        "finishedAt": "example",
        "state": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Create deployment

Creates a new model deployment associated with one or more gateways.

**Inputs**

- ID (`id`, text): The unique identifier of the deployment, UUID format
- Name (`name`, text, required): The name of the deployment
- Gateway IDS (`gateway_ids`, list, required): The gateways to associate the deployment with
- Runtime (`runtime`, object, required): Runtime selection and configuration
- Resources (`resources`, object, required): Resource configuration for the deployment
- Model (`model`, object, required): The model configuration
- Autoscaling (`autoscaling`, object, required): The autoscaling configuration
- Traffic (`traffic`, object, required): The traffic configuration for the deployment
- Disabled (`disabled`, true/false): Disable the deployment
- Hot load (`hot_load`, object): The hot-load configuration for the deployment. Set it to enable checkpoint hot-loading; it is immutable after creation.
- Pd (`pd`, object): Prefill/Decode disaggregation configuration. Top-level resources and autoscaling configure the decode pool; this field configures the prefill pool. Only supported by dynamo-vllm when the pdDisaggEnabled feature flag is enabled.

**Outputs**

- `data` (object): Response for CreateDeployment

**Example output**

```json
{
  "data": {
    "deployment": {
      "spec": {
        "autoscaling": {},
        "disabled": false,
        "gatewayIds": [],
        "hotLoad": {},
        "id": "example",
        "model": {},
        "name": "example",
        "organizationId": "example",
        "pd": {},
        "resources": {},
        "runtime": {},
        "traffic": {}
      },
      "status": {
        "conditions": [],
        "createdAt": "example",
        "specRevision": "example",
        "status": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Create gateway

Creates a new inference gateway. Each gateway must be configured with exactly one authentication type and exactly one routing strategy.

**Inputs**

- ID (`id`, text): The unique identifier of the gateway, UUID format
- Name (`name`, text, required): The human readable name of the gateway. Capped at 38 characters so the derived production FQDN (..gw.cwinference.com) fits within the 64-character X.509 Common Name limit.
- Zones (`zones`, list): The zones to make the gateway available in, limits where deployments associated with the gateway may exist, no zones means all may be used.
- Core weave auth (`core_weave_auth`, object): CoreWeave IAM
- Weights and biases auth (`weights_and_biases_auth`, object): Weights & Biases
- Endpoint configuration (`endpoint_configuration`, object): Additional endpoint configuration options
- Body based routing (`body_based_routing`, object): Body based routing
- Header based routing (`header_based_routing`, object): Header based routing
- Path based routing (`path_based_routing`, object): Path based routing

**Outputs**

- `data` (object): Response for CreateGateway

**Example output**

```json
{
  "data": {
    "gateway": {
      "spec": {
        "bodyBasedRouting": {},
        "coreWeaveAuth": {},
        "endpointConfiguration": {},
        "headerBasedRouting": {},
        "id": "example",
        "name": "example",
        "organizationId": "example",
        "pathBasedRouting": {},
        "weightsAndBiasesAuth": {},
        "zones": []
      },
      "status": {
        "conditions": [],
        "createdAt": "example",
        "endpoints": [],
        "status": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Delete capacity claim

Deletes a CapacityClaim by ID. Returns the deleted CapacityClaim.

**Inputs**

- ID (`id`, text, required): The unique identifier of the CapacityClaim to delete, UUID format

**Outputs**

- `data` (object): Response for DeleteCapacityClaim

**Example output**

```json
{
  "data": {
    "capacityClaim": {
      "spec": {
        "id": "example",
        "name": "example",
        "organizationId": "example",
        "resources": {}
      },
      "status": {
        "allocatedInstances": 1,
        "conditions": [],
        "createdAt": "example",
        "pendingInstances": 1,
        "status": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Delete deployment

Deletes a deployment by ID. Returns the deleted deployment.

**Inputs**

- ID (`id`, text, required): The ID of the deployment to delete

**Outputs**

- `data` (object): Response for DeleteDeployment

**Example output**

```json
{
  "data": {
    "deployment": {
      "spec": {
        "autoscaling": {},
        "disabled": false,
        "gatewayIds": [],
        "hotLoad": {},
        "id": "example",
        "model": {},
        "name": "example",
        "organizationId": "example",
        "pd": {},
        "resources": {},
        "runtime": {},
        "traffic": {}
      },
      "status": {
        "conditions": [],
        "createdAt": "example",
        "specRevision": "example",
        "status": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Delete gateway

Deletes a gateway by ID. Returns the deleted gateway.

**Inputs**

- ID (`id`, text, required): The unique identifier of the gateway to delete, UUID format

**Outputs**

- `data` (object): Response for DeleteGateway

**Example output**

```json
{
  "data": {
    "gateway": {
      "spec": {
        "bodyBasedRouting": {},
        "coreWeaveAuth": {},
        "endpointConfiguration": {},
        "headerBasedRouting": {},
        "id": "example",
        "name": "example",
        "organizationId": "example",
        "pathBasedRouting": {},
        "weightsAndBiasesAuth": {},
        "zones": []
      },
      "status": {
        "conditions": [],
        "createdAt": "example",
        "endpoints": [],
        "status": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Get capacity claim

Retrieves a single CapacityClaim by its UUID.

**Inputs**

- ID (`id`, text, required): The unique identifier of the CapacityClaim to get, UUID format

**Outputs**

- `data` (object): Response for GetCapacityClaim

**Example output**

```json
{
  "data": {
    "capacityClaim": {
      "spec": {
        "id": "example",
        "name": "example",
        "organizationId": "example",
        "resources": {}
      },
      "status": {
        "allocatedInstances": 1,
        "conditions": [],
        "createdAt": "example",
        "pendingInstances": 1,
        "status": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Get checkpoint hot-load

Returns a hot-load by ID, including its resolved snapshot chain and aggregate state.

**Inputs**

- ID (`id`, text, required): The ID of the hot-load

**Outputs**

- `data` (object): Response for GetHotLoad

**Example output**

```json
{
  "data": {
    "hotLoad": {
      "spec": {
        "deploymentId": "example",
        "id": "example",
        "identity": "example",
        "incrementalSnapshotMetadata": {},
        "organizationId": "example",
        "promptCachePolicy": "example",
        "snapshotChain": [],
        "type": "example"
      },
      "status": {
        "canceledAt": "example",
        "conditions": [],
        "createdAt": "example",
        "finishedAt": "example",
        "state": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Get deployment

Retrieves a single deployment by ID.

**Inputs**

- ID (`id`, text, required): The ID of the deployment to get

**Outputs**

- `data` (object): Response for GetDeployment

**Example output**

```json
{
  "data": {
    "deployment": {
      "spec": {
        "autoscaling": {},
        "disabled": false,
        "gatewayIds": [],
        "hotLoad": {},
        "id": "example",
        "model": {},
        "name": "example",
        "organizationId": "example",
        "pd": {},
        "resources": {},
        "runtime": {},
        "traffic": {}
      },
      "status": {
        "conditions": [],
        "createdAt": "example",
        "specRevision": "example",
        "status": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Get deployment parameters

Returns the available gateways, runtime engines and versions, runtime config keys, and instance types for use when creating a deployment.

**Inputs**

- Gateway IDS (`gateway_ids`, list): Optional set of gateway IDs to scope the returned parameters to. When provided, the response enumerates only the values valid across every listed gateway, so a deployment targeting this exact set and using only the returned values passes validation. Empty means all of the…

**Outputs**

- `data` (object): Response for GetDeploymentParameters

**Example output**

```json
{
  "data": {
    "gatewayIds": [],
    "resourceParameters": {
      "instanceTypes": []
    },
    "runtimeParameters": {
      "engineEnvOptions": {},
      "runtimeConfigOptions": {},
      "runtimeEngineOptions": {},
      "runtimeVersions": {}
    }
  }
}
```

### Get gateway

Retrieves a single gateway by its UUID.

**Inputs**

- ID (`id`, text, required): The unique identifier of the reservation to get, UUID format

**Outputs**

- `data` (object): Response for GetGateway

**Example output**

```json
{
  "data": {
    "gateway": {
      "spec": {
        "bodyBasedRouting": {},
        "coreWeaveAuth": {},
        "endpointConfiguration": {},
        "headerBasedRouting": {},
        "id": "example",
        "name": "example",
        "organizationId": "example",
        "pathBasedRouting": {},
        "weightsAndBiasesAuth": {},
        "zones": []
      },
      "status": {
        "conditions": [],
        "createdAt": "example",
        "endpoints": [],
        "status": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### List capacity claims

Returns every CapacityClaim that the caller can read.

**Inputs**

- Updated after (`updated_after`, date and time): Filter by those updated after this timestamp

**Outputs**

- `data` (object): Response for ListCapacityClaims

**Example output**

```json
{
  "data": {
    "capacityClaims": []
  }
}
```

### List checkpoint hot-loads

Returns the caller's hot-loads, newest first, optionally filtered to a single deployment.

**Inputs**

- Parent deployment (`parent_deployment_id`, text): The ID of a deployment to filter by. When omitted, every hot-load in the caller's organization is returned.
- Max page size (`max_page_size`, number): The maximum number of hot-loads to return. The service may return fewer than this value. If unspecified or 0, at most 50 hot-loads are returned. The maximum value is 1000; values above 1000 are coerced to 1000. A negative value is rejected with INVALID_ARGUMENT.
- Page token (`page_token`, text): A page token received from a previous ListHotLoads call. Provide this to retrieve the subsequent page. Use the same parent_deployment_id filter, including leaving it unset if it was unset in the previous call. A token used with a different filter is rejected with…

**Outputs**

- `data` (object): Response for ListHotLoads

**Example output**

```json
{
  "data": {
    "hotLoads": [],
    "nextPageToken": "example"
  }
}
```

### List deployments

Returns every deployment that the caller can read, optionally filtered by parent gateway or update timestamp.

**Inputs**

- Parent gateway (`parent_gateway_id`, text): The ID of the parent gateway to filter deployments by
- Updated after (`updated_after`, date and time): Filter by those updated after this timestamp

**Outputs**

- `data` (object): Response for ListDeployments

**Example output**

```json
{
  "data": {
    "items": []
  }
}
```

### List gateways

Returns every inference gateway that the caller can read, optionally filtered by update timestamp.

**Inputs**

- Updated after (`updated_after`, date and time): Filter by those updated after this timestamp

**Outputs**

- `data` (object): Response for ListGateways

**Example output**

```json
{
  "data": {
    "items": []
  }
}
```

### List hot-load replicas

Returns the replicas of one hot-load, ordered by zone and name, in pages.

**Inputs**

- Hot load (`hot_load_id`, text, required): The ID of the hot-load whose replicas to list
- Max page size (`max_page_size`, number): The maximum number of replicas to return. The service may return fewer than this value. If unspecified or 0, at most 50 replicas are returned. The maximum value is 1000; values above 1000 are coerced to 1000. A negative value is rejected with INVALID_ARGUMENT.
- Page token (`page_token`, text): A page token received from a previous ListHotLoadReplicas call. Provide this to retrieve the subsequent page. Use the same hot_load_id and organization as the previous call; otherwise, the token is rejected with INVALID_ARGUMENT. The token is opaque and must not be…

**Outputs**

- `data` (object): Response for ListHotLoadReplicas

**Example output**

```json
{
  "data": {
    "nextPageToken": "example",
    "replicas": []
  }
}
```

### Update deployment

Updates an existing deployment. The request body replaces the deployment's spec; this endpoint does not accept a field mask.

**Inputs**

- ID (`id`, text, required): The ID of the deployment to update
- Name (`name`, text): The name of the deployment
- Gateway IDS (`gateway_ids`, list): The gateways to associate the deployment with
- Runtime (`runtime`, object): Runtime selection and configuration
- Resources (`resources`, object): Resource configuration for the deployment
- Model (`model`, object): The model configuration
- Autoscaling (`autoscaling`, object): The autoscaling configuration
- Traffic (`traffic`, object): The traffic configuration for the deployment
- Disabled (`disabled`, true/false): Disable the deployment
- Hot load (`hot_load`, object): The hot-load configuration for the deployment. Immutable: it must match the value set at creation.
- Pd (`pd`, object): Prefill/Decode disaggregation configuration. Top-level resources and autoscaling configure the decode pool; this field configures the prefill pool. Only supported by dynamo-vllm when the pdDisaggEnabled feature flag is enabled.

**Outputs**

- `data` (object): Response for UpdateDeployment

**Example output**

```json
{
  "data": {
    "deployment": {
      "spec": {
        "autoscaling": {},
        "disabled": false,
        "gatewayIds": [],
        "hotLoad": {},
        "id": "example",
        "model": {},
        "name": "example",
        "organizationId": "example",
        "pd": {},
        "resources": {},
        "runtime": {},
        "traffic": {}
      },
      "status": {
        "conditions": [],
        "createdAt": "example",
        "specRevision": "example",
        "status": "example",
        "updatedAt": "example"
      }
    }
  }
}
```

### Update gateway

Updates an existing gateway. The request body replaces the gateway's spec; this endpoint does not accept a field mask.

**Inputs**

- ID (`id`, text, required): The unique identifier of the gateway to update, UUID format
- Name (`name`, text): The human readable name of the gateway. Capped at 38 characters, matching CreateGatewayRequest.name.
- Zones (`zones`, list): The zones to make the gateway available in, limits where deployments associated with the gateway may exist, no zones means all may be used.
- Core weave auth (`core_weave_auth`, object): CoreWeave IAM
- Weights and biases auth (`weights_and_biases_auth`, object): Weights & Biases
- Endpoint configuration (`endpoint_configuration`, object): Additional endpoint configuration options
- Body based routing (`body_based_routing`, object): Body based routing
- Header based routing (`header_based_routing`, object): Header based routing
- Path based routing (`path_based_routing`, object): Path based routing

**Outputs**

- `data` (object): Response for UpdateGateway

**Example output**

```json
{
  "data": {
    "gateway": {
      "spec": {
        "bodyBasedRouting": {},
        "coreWeaveAuth": {},
        "endpointConfiguration": {},
        "headerBasedRouting": {},
        "id": "example",
        "name": "example",
        "organizationId": "example",
        "pathBasedRouting": {},
        "weightsAndBiasesAuth": {},
        "zones": []
      },
      "status": {
        "conditions": [],
        "createdAt": "example",
        "endpoints": [],
        "status": "example",
        "updatedAt": "example"
      }
    }
  }
}
```
