Quickstart

This quickstart creates a GPT Image 2 task, captures its APIPod task ID, and polls the result endpoint.

Create an API key

Set local environment variables

export APIPOD_API_KEY="your-api-key"
export APIPOD_IDEMPOTENCY_KEY="image-$(date +%s)"

Use a stable, unique idempotency key for one logical create operation. If a network failure makes the result ambiguous, retry with the same key and unchanged JSON body.

Create an image task

curl https://api.apipod.ai/v1/images/generations \
  -H "Authorization: Bearer $APIPOD_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $APIPOD_IDEMPOTENCY_KEY" \
  -d '{
    "model": "gpt-image-2",
    "prompt": "A clean product photograph of a translucent glass speaker, soft studio lighting",
    "aspect_ratio": "1:1",
    "resolution": "1K"
  }'

A successful create response has this envelope:

{
  "code": 200,
  "message": "success",
  "data": {
    "task_id": "img_example_task_id"
  }
}

Poll the task

export APIPOD_TASK_ID="img_example_task_id"

curl "https://api.apipod.ai/v1/images/status/$APIPOD_TASK_ID" \
  -H "Authorization: Bearer $APIPOD_API_KEY"

Continue polling while the status is pending or processing. Stop when it becomes completed, failed, or cancelled.

Completed response

{
  "code": 200,
  "message": "success",
  "data": {
    "task_id": "img_example_task_id",
    "status": "completed",
    "result": [
      "https://example.com/generated-image.png"
    ],
    "completed_at": 1786358400
  }
}

HTTP 200 from the create endpoint means the task was accepted. It does not mean the image or video has finished generating.

GPT Image 2 parameters

Review every supported field and all five language examples.

Task lifecycle

Add production polling, webhooks, and terminal-state handling.

Overview

Core concepts

Completed response

GPT Image 2 parameters

Task lifecycle

​Completed response

GPT Image 2 parameters

Task lifecycle

Completed response