API Documentation

The PixelDojo API allows agents and applications to access our AI image and video generation capabilities programmatically. To use the API, you'll need:

• An API key (create one in the API Keys section)
• Credits for generation (per-image for image models, per-second for video models)
• Review model-specific parameters in API Platform or fetch /api/v1/models/{apiId}/schema

API access does not require an active subscription. Signed-in users can create keys and purchase credits directly.

npm install @pixeldojo/sdk

import { PixelDojoClient } from "@pixeldojo/sdk";

const pd = new PixelDojoClient({ apiKey: "pd_your_api_key" });

// Submit + poll until complete
const job = await pd.generate("flux-1.1-pro", {
  prompt: "A fantasy castle on a cliff at sunset",
  aspect_ratio: "16:9",
});

console.log(job.assets[0].url);

@pixeldojo/sdk on npm · Zero runtime dependencies · ESM + CJS · Full TypeScript types

All API requests must include your API key in the request headers.

API keys are available to signed-in users and work with prepaid credits. You do not need an active subscription to use the API.

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

To ensure fair usage and system stability, the PixelDojo API has the following rate limits:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Reset: 1619284800

The API uses standard HTTP status codes to indicate the success or failure of requests.

{
  "error": {
    "code": "insufficient_credits",
    "message": "Your account has insufficient credits",
    "status": 403
  }
}

Model-specific parameters vary. See /api/v1/models/{apiId}, /api/v1/models/{apiId}/schema, or the model detail page for the full schema.

# Submit a job
curl -X POST "https://pixeldojo.ai/api/v1/models/flux-1.1-pro/run" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "A sunset", "aspect_ratio": "1:1", "webhook_url": "https://example.com/webhook"}'

# Poll for results
curl "https://pixeldojo.ai/api/v1/jobs/job_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"

# List recent jobs
curl "https://pixeldojo.ai/api/v1/jobs?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Replay a terminal webhook
curl -X POST "https://pixeldojo.ai/api/v1/jobs/job_abc123/webhook" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "jobId": "job_abc123",
  "status": "pending",
  "statusUrl": "https://pixeldojo.ai/api/v1/jobs/job_abc123",
  "creditCost": 1,
  "creditsRemaining": 99,
  "expiresAt": "2025-01-23T12:00:00Z"
}

{
  "jobId": "job_abc123",
  "status": "completed",
  "output": {
    "images": [
      "https://temp.pixeldojo.ai/pixeldojotemp/1686432789123-abc123-0.png"
    ]
  },
  "creditCost": 1,
  "expiresAt": "2025-01-23T12:00:00Z"
}

PixelDojo provides multiple discovery endpoints so AI agents can automatically find, understand, and use the API. Pair these with the schema and job routes above to build MCP-style tools, CLIs, or generated SDKs.