OpenAPI Specification

v3.1

Industry-standard API specification for SDKs, CLIs, and agent runtimes

What is OpenAPI?

The industry standard for API documentation

OpenAPI (formerly Swagger) is a standard specification for describing RESTful APIs. Our OpenAPI 3.1 specification provides a complete, machine-readable description of the PixelDojo API, including per-model request schemas, job control-plane routes, and the core contract needed to generate SDKs or build agent tooling.

Complete Endpoints

All API endpoints with request/response schemas

Per-Model Schemas

Model-specific request bodies for typed clients and agent planning

Control Plane

Discovery, job listing, status inspection, and webhook replay routes

Import Into Your Favorite Tools

Use the OpenAPI spec with popular API development tools

Postman

Import into Postman

Open Postman and click Import
Select Link and paste the OpenAPI URL
Click Continue to import all endpoints
Set up your API key in the collection variables

https://pixeldojo.ai/api/openapi

Swagger UI

View in Swagger UI

Use the online Swagger Editor to explore the API interactively:

Swagger Editor URL

Open in Swagger Editor

Insomnia

Import into Insomnia

Open Insomnia and go to Application > Preferences > Data
Click Import Data > From URL
Paste the OpenAPI URL and import

Generate Client SDKs

Automatically create typed clients in your preferred language

Use OpenAPI Generator to create client libraries in over 50 languages. The spec is now rich enough to serve as the contract for first-party TypeScript and Python SDKs or a thin CLI wrapper.

Generate TypeScript Client

npx @openapitools/openapi-generator-cli generate \
  -i https://pixeldojo.ai/api/openapi \
  -g typescript-fetch \
  -o ./pixeldojo-client

Generate Python Client

npx @openapitools/openapi-generator-cli generate \
  -i https://pixeldojo.ai/api/openapi \
  -g python \
  -o ./pixeldojo-python

Available generators include: typescript-fetch, typescript-axios, python, go, java, ruby, csharp, and many more.

Specification Structure

Overview of what's included in the OpenAPI spec

Endpoints

GET /api/v1/models/{apiId}/schema - Canonical request schema
POST /api/v1/models/{apiId}/run - Start generation job
GET /api/v1/jobs - List recent jobs
GET /api/v1/jobs/{jobId} - Check job status
POST /api/v1/jobs/{jobId}/webhook - Replay terminal webhook

Schemas

{ModelName}Request - Per-model input schema
JobResponse - Job status and output
AssetReference - Stable per-job asset handles
WebhookState - Delivery status and replay state
ModelInfo - Model details
ErrorResponse - Error format

Recommended Product Surfaces

How to turn the OpenAPI contract into installable tooling for agent builders

The current spec supports three install patterns: generated SDKs, a thin CLI wrapper over the public routes, and MCP-style tools that delegate to /models, /models/{apiId}/schema, /models/{apiId}/run, /jobs, and /jobs/{jobId}/webhook.

For a first-party SDK, prioritize typed request builders, polling helpers, and webhook replay helpers. For a CLI, mirror the API lifecycle with commands like models, schema, run, jobs, and replay-webhook.

Full API Documentation LLM.txt Documentation Raw OpenAPI JSON API Keys Usage Dashboard Buy Credits