Schemas¶

Key data models used in the Compute API. For the complete schema reference, see the OpenAPI specification.

Task Models¶

Task¶

Base task representation.

{
  "id": "string",
  "type": "generation | training | workflow",
  "status": "pending | running | completed | failed | cancelled",
  "created_at": "datetime",
  "started_at": "datetime | null",
  "completed_at": "datetime | null",
  "error": "string | null",
  "metadata": {}
}

GenerationTask¶

Image generation task.

{
  "id": "string",
  "type": "generation",
  "status": "pending | running | completed | failed | cancelled",
  "input": {
    "image_url": "string",
    "prompt": "string",
    "negative_prompt": "string | null",
    "model": "string",
    "seed": "integer | null",
    "steps": "integer",
    "guidance_scale": "float",
    "num_outputs": "integer"
  },
  "output": {
    "images": [
      {
        "url": "string",
        "seed": "integer"
      }
    ]
  } | null,
  "progress": "float",
  "created_at": "datetime",
  "completed_at": "datetime | null"
}

TrainingTask¶

Model training task.

{
  "id": "string",
  "type": "training",
  "status": "pending | running | completed | failed | cancelled",
  "input": {
    "dataset_url": "string",
    "base_model": "string",
    "config": {
      "epochs": "integer",
      "learning_rate": "float",
      "batch_size": "integer"
    }
  },
  "output": {
    "model_url": "string",
    "metrics": {
      "loss": "float",
      "epochs_completed": "integer"
    }
  } | null,
  "progress": "float",
  "created_at": "datetime"
}

Workflow Models¶

Workflow¶

Multi-step processing pipeline.

{
  "id": "string",
  "name": "string",
  "status": "pending | running | paused | completed | failed",
  "steps": [
    {
      "id": "string",
      "name": "string",
      "type": "generation | processing | storage",
      "status": "pending | running | completed | failed | skipped",
      "input": {},
      "output": {} | null
    }
  ],
  "current_step": "integer",
  "created_at": "datetime",
  "started_at": "datetime | null",
  "completed_at": "datetime | null"
}

WorkflowStep¶

Individual step in a workflow.

{
  "id": "string",
  "name": "string",
  "type": "generation | processing | storage",
  "status": "pending | running | completed | failed | skipped",
  "depends_on": ["string"],
  "input": {},
  "output": {} | null,
  "error": "string | null",
  "started_at": "datetime | null",
  "completed_at": "datetime | null"
}

Monitoring Models¶

QueueStatus¶

Task queue status.

{
  "name": "string",
  "pending": "integer",
  "running": "integer",
  "workers": "integer",
  "throughput_per_minute": "float"
}

WorkerStatus¶

Worker pool status.

{
  "id": "string",
  "status": "idle | busy | offline",
  "current_task_id": "string | null",
  "gpu_info": {
    "name": "string",
    "memory_total_gb": "float",
    "memory_used_gb": "float",
    "utilization_percent": "float"
  },
  "last_heartbeat": "datetime"
}

SystemStats¶

System-wide statistics.

{
  "tasks_completed_24h": "integer",
  "tasks_failed_24h": "integer",
  "average_task_duration_seconds": "float",
  "active_workers": "integer",
  "queue_depth": "integer"
}

Request Models¶

CreateGenerationTask¶

{
  "input_image_url": "string (required)",
  "prompt": "string (required)",
  "negative_prompt": "string",
  "model": "string",
  "seed": "integer",
  "steps": "integer (default: 30)",
  "guidance_scale": "float (default: 7.5)",
  "num_outputs": "integer (default: 1, max: 4)"
}

CreateTrainingTask¶

{
  "dataset_url": "string (required)",
  "base_model": "string (required)",
  "output_name": "string (required)",
  "config": {
    "epochs": "integer (default: 100)",
    "learning_rate": "float (default: 1e-4)",
    "batch_size": "integer (default: 1)"
  }
}

CreateWorkflow¶

{
  "name": "string (required)",
  "steps": [
    {
      "name": "string (required)",
      "type": "string (required)",
      "config": {},
      "depends_on": ["string"]
    }
  ]
}

Enums¶

Task Status¶

Value	Description
`pending`	Queued, waiting for worker
`running`	Currently executing
`completed`	Successfully finished
`failed`	Error occurred
`cancelled`	Cancelled by user

Worker Status¶

Value	Description
`idle`	Available for tasks
`busy`	Processing a task
`offline`	Not responding

Workflow Status¶

Value	Description
`pending`	Not yet started
`running`	Steps executing
`paused`	Manually paused
`completed`	All steps finished
`failed`	A step failed