> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Pika 2.5 Image To Video with Comfy Router

> Call pika/pika-2.5-image-to-video through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `pika/pika-2.5-image-to-video`, served by Comfy Router from Pika.

**Input:** Text, Image · **Output:** Video

## Quick start

Create a key in [your Comfy workspace](https://platform.comfy.org/profile/api-keys?onboarding=router) and export it as `COMFY_API_KEY`. The Python and TypeScript snippets use the Comfy SDKs (`pip install comfy-sdk` and `npm install @comfyorg/sdk`); the cURL snippet is the same call over raw HTTP.

**Model ID:** `pika/pika-2.5-image-to-video`

**Endpoint:** `POST https://api.comfy.org/v2/models/pika/pika-2.5-image-to-video`

**Wait for the result**

```python Python theme={null}
from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment.
# The SDK automatically creates an idempotency key and reuses it for automatic retries.
with Comfy() as client:
    result = client.models.run(
        "pika/pika-2.5-image-to-video",
        {
            "duration_s": 5,
            "image": "https://example.invalid/pika/source.png",
            "prompt": "The camera slowly pushes in as the leaves begin to sway",
            "resolution": "720p",
        },
    )

print(result)
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// Reads COMFY_API_KEY from the environment.
// The SDK automatically creates an idempotency key and reuses it for automatic retries.
const { data } = await comfy.models.run("pika/pika-2.5-image-to-video", {
  duration_s: 5,
  image: "https://example.invalid/pika/source.png",
  prompt: "The camera slowly pushes in as the leaves begin to sway",
  resolution: "720p",
});

console.log(data);
```

```bash cURL theme={null}
curl https://api.comfy.org/v2/models/pika/pika-2.5-image-to-video \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"duration_s\": 5, \"image\": \"https://example.invalid/pika/source.png\", \"prompt\": \"The camera slowly pushes in as the leaves begin to sway\", \"resolution\": \"720p\"}"
```

**Queue and collect later**

The same body, sent to `POST https://api.comfy.org/v2/models/pika/pika-2.5-image-to-video/requests`. Router answers `201` with a `request_id` as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. [Queued delivery](https://docs.comfy.org/development/comfy-router/queue.md) walks through status, cancellation and collection.

```python Python theme={null}
import asyncio
from comfy_sdk import AsyncComfy

# Reads COMFY_API_KEY from the environment.
# Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
async def main():
    async with AsyncComfy() as client:
        handle = await client.models.submit(
            "pika/pika-2.5-image-to-video",
            {
                "duration_s": 5,
                "image": "https://example.invalid/pika/source.png",
                "prompt": "The camera slowly pushes in as the leaves begin to sway",
                "resolution": "720p",
            },
        )
        print("request_id:", handle.request_id)  # with the model ID, all another process needs

        # Poll until the request completes, waiting the Retry-After the server names.
        async for update in handle.iter_events():
            print(update.status, update.queue_position)

        # The provider's own payload, the same value models.run() returns.
        # A request that failed or was cancelled raises the typed Router error here.
        result = await handle.get()

    print(result)

asyncio.run(main())
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// Reads COMFY_API_KEY from the environment.
// Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
const handle = await comfy.models.submit("pika/pika-2.5-image-to-video", {
  duration_s: 5,
  image: "https://example.invalid/pika/source.png",
  prompt: "The camera slowly pushes in as the leaves begin to sway",
  resolution: "720p",
});
console.log("requestId:", handle.requestId); // with the model ID, all another process needs

// Poll until the request completes, waiting the Retry-After the server names.
for await (const update of handle.events()) {
  console.log(update.status, update.queuePosition);
}

// The same result models.run() returns. A request that failed or was cancelled rejects here.
const result = await handle.get();

console.log(result.data);
```

```bash cURL theme={null}
# 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
curl https://api.comfy.org/v2/models/pika/pika-2.5-image-to-video/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"duration_s\": 5, \"image\": \"https://example.invalid/pika/source.png\", \"prompt\": \"The camera slowly pushes in as the leaves begin to sway\", \"resolution\": \"720p\"}"

# 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
REQUEST_ID="<request_id from the 201 body>"
curl -i https://api.comfy.org/v2/models/pika/pika-2.5-image-to-video/requests/$REQUEST_ID/status \
  -H "X-API-Key: $COMFY_API_KEY"

# 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
curl https://api.comfy.org/v2/models/pika/pika-2.5-image-to-video/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"
```

## Schema

### Input

**duration\_s** `integer` (default: 5)

Video length in seconds.

Possible values: `5`, `10`

**image** `string` *required*

Public https URL of the source image to animate. The image carries the subject. Plain `http://` is refused: Pika fetches the URL on a request sent under Comfy's key.

**negative\_prompt** `string`

Text describing what to avoid in the video.

**prompt** `string`

Text prompt guiding the motion.

**resolution** `string` (default: "1080p")

Output resolution.

Possible values: `720p`, `1080p`

**seed** `integer`

Seed for reproducible generation. Omit it (or send null) for a random seed.

Generated from the schema Router serves at `GET /v2/models/pika/pika-2.5-image-to-video/openapi.json`, the same document it validates a call against before the request reaches the provider.

### Output

**error** `object`

Pika's structured failure record, set on a `failed` job. Router answers a failed job with its own error response, so a body Router returns does not carry it; it is declared because it is part of Pika's job document.

**error.code** `string` *required*

Possible values: `invalid_input`, `content_moderation`, `provider_error`, `provider_timeout`, `provider_unavailable`, `rate_limited`, `insufficient_balance`, `membership_required`, `cycle_limit_exceeded`, `admission_suspended`, `usage_limit_exceeded`, `timed_out`, `internal`

**error.message** `string` *required*

**id** `string` *required*

Pika's job id.

**model\_id** `string`

The Pika catalog entry the job ran.

**output** `object`

The finished job's media, set when `status` is `completed`. `media_type` says which field carries it: `image` fills `images`, `video` fills `video`, and `videos` fills `videos`.

**output.images** `object[]`

Generated images, for an image model.

**output.images\[].content\_type** `string`

MIME type of the file.

**output.images\[].height** `integer`

Height in pixels.

**output.images\[].url** `string`

Download URL of the generated file.

**output.images\[].width** `integer`

Width in pixels.

**output.media\_type** `string`

Possible values: `image`, `video`, `videos`

**output.seed** `integer`

The seed the video job actually used, when reported.

**output.video** `object`

One generated media file.

**output.video.content\_type** `string`

MIME type of the file.

**output.video.height** `integer`

Height in pixels.

**output.video.url** `string`

Download URL of the generated file.

**output.video.width** `integer`

Width in pixels.

**output.videos** `object[]`

Generated videos, for a multi-video delivery.

**output.videos\[].content\_type** `string`

MIME type of the file.

**output.videos\[].height** `integer`

Height in pixels.

**output.videos\[].url** `string`

Download URL of the generated file.

**output.videos\[].width** `integer`

Width in pixels.

**runtime\_s** `number`

Seconds the generation took, from dispatch to terminal. Best-effort; may be null.

**status** `string` *required*

Lifecycle state. A body Router returns always reads `completed`; a `failed` job is answered with Router's error response instead.

Possible values: `queued`, `running`, `completed`, `failed`

**usage** `object`

Provider-reported units for the job. Keys are sparse; only the units the job reports are present.

## Examples

### Input

```json theme={null}
{
  "duration_s": 5,
  "image": "https://example.invalid/pika/source.png",
  "prompt": "The camera slowly pushes in as the leaves begin to sway",
  "resolution": "720p"
}
```

### Output

```json theme={null}
{
  "id": "2d8e4b71-9c05-4f3a-b6d2-81e7a5c09f44",
  "model_id": "pika/pika-2.5/image-to-video",
  "output": {
    "media_type": "video",
    "seed": 42,
    "video": {
      "content_type": "video/mp4",
      "height": 720,
      "url": "https://example.invalid/pika/pika-2.5-image-to-video/generated.mp4",
      "width": 1280
    }
  },
  "status": "completed"
}
```

## Before you ship

The SDKs create an `Idempotency-Key` and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes.

When a request fails, Router sends an `X-Comfy-Error-Type` response header explaining why. A `422` means Router rejected the input before calling the provider, and a `413` means the request body was larger than Router accepts. Download generated assets promptly because [result URLs can expire](https://docs.comfy.org/development/comfy-router/reference.md#result-assets).

Any size limit named in a field description above is the provider's own bound on that field, quoted from the provider's specification. Router applies a separate cap to the whole request body, which base64-encoded media counts against: see [request body size](https://docs.comfy.org/development/comfy-router/limitations.md#request-bodies-are-capped).

This page documents one partner model called through Comfy Router. The same `comfy-sdk` / `@comfyorg/sdk` package also ships a second client, for running a whole ComfyUI workflow graph on Comfy Cloud: `Comfy(api_key=...)` / `new Comfy({ apiKey })`, with `client.workflows`, `client.assets` and `client.jobs`. See [Comfy SDKs](https://docs.comfy.org/development/api-development/sdks.md).

> **[Headers](https://docs.comfy.org/development/comfy-router/headers.md)**
>
> Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

> **[Using the Router API](https://docs.comfy.org/development/comfy-router/api.md)**
>
> Model discovery, validation errors, retries, and billing.

> **[Limitations](https://docs.comfy.org/development/comfy-router/limitations.md)**
>
> What Router does not do today, and what to use instead.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.