POST /v1/snapshots — Create a capsule snapshot template

POST https://app.wrenn.dev/api/v1/snapshots

curl -X POST "https://app.wrenn.dev/api/v1/snapshots?overwrite=true" \
  -H "X-API-Key: wrn_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "sandbox_id": "cl-abc123",
    "name": "my-template"
  }'

{
  "sandbox_id": "cl-abc123",
  "name": "my-template"
}

## Response

Returns `201 Created` with a `Template` object.

<ResponseField name="name" type="string" required>
  The name of the snapshot template. Use this value as the `template` parameter when creating new capsules.
</ResponseField>

<ResponseField name="type" type="string" required>
  Always `"snapshot"` for templates created via this endpoint.
</ResponseField>

<ResponseField name="vcpus" type="integer">
  Number of vCPUs captured in the snapshot. May be `null` for base templates.
</ResponseField>

<ResponseField name="memory_mb" type="integer">
  Memory in MiB captured in the snapshot. May be `null` for base templates.
</ResponseField>

<ResponseField name="size_bytes" type="integer">
  Total size of the snapshot files on disk, in bytes.
</ResponseField>

<ResponseField name="created_at" type="string" required>
  ISO 8601 timestamp of when the snapshot was created.
</ResponseField>

### Example response

```json
{
  "name": "my-template",
  "type": "snapshot",
  "vcpus": 2,
  "memory_mb": 1024,
  "size_bytes": 536870912,
  "created_at": "2024-11-01T10:00:00Z"
}

from wrenn import Capsule

with Capsule(template="base-python", wait=True) as capsule:
    # ... set up your environment ...

    # Snapshot the capsule into a reusable template
    # Note: this destroys the capsule
    template = capsule.create_snapshot(name="my-template", overwrite=True)
    print(template.name)        # "my-template"
    print(template.size_bytes)  # 536870912