Replicate · JSON Structure

Replicate Prediction Structure

Structure of a prediction object returned by the Replicate API.

Type: Properties: 0
Artificial IntelligenceMachine LearningImage GenerationLanguage ModelsModel Deployment

Replicate Prediction is a JSON Structure definition published by Replicate.

Meta-schema:

JSON Structure

Raw ↑
{
  "name": "Replicate Prediction",
  "description": "Structure of a prediction object returned by the Replicate API.",
  "fields": [
    {
      "name": "id",
      "type": "string",
      "required": true,
      "description": "Unique prediction identifier (e.g. xyz123abc456)"
    },
    {
      "name": "version",
      "type": "string",
      "required": false,
      "description": "Model version ID used for versioned predictions"
    },
    {
      "name": "model",
      "type": "string",
      "required": false,
      "description": "Model reference (owner/name) for official model predictions"
    },
    {
      "name": "status",
      "type": "enum",
      "required": true,
      "values": ["starting", "processing", "succeeded", "failed", "canceled"],
      "description": "Current lifecycle status of the prediction"
    },
    {
      "name": "input",
      "type": "object",
      "required": true,
      "description": "Model-specific input parameters"
    },
    {
      "name": "output",
      "type": "any",
      "required": false,
      "description": "Model output - type varies by model (string, array, object)"
    },
    {
      "name": "error",
      "type": "string",
      "required": false,
      "description": "Error message if prediction failed"
    },
    {
      "name": "logs",
      "type": "string",
      "required": false,
      "description": "Log output from the prediction container"
    },
    {
      "name": "metrics",
      "type": "object",
      "required": false,
      "description": "Performance metrics (predict_time, total_time)"
    },
    {
      "name": "urls",
      "type": "object",
      "required": false,
      "description": "Hypermedia URLs for get, cancel, and stream operations"
    },
    {
      "name": "created_at",
      "type": "datetime",
      "required": true,
      "description": "ISO 8601 timestamp when prediction was created"
    },
    {
      "name": "started_at",
      "type": "datetime",
      "required": false,
      "description": "ISO 8601 timestamp when prediction started processing"
    },
    {
      "name": "completed_at",
      "type": "datetime",
      "required": false,
      "description": "ISO 8601 timestamp when prediction completed"
    },
    {
      "name": "source",
      "type": "enum",
      "required": false,
      "values": ["api", "web"],
      "description": "How the prediction was created"
    },
    {
      "name": "webhook",
      "type": "string",
      "required": false,
      "description": "Webhook URL for async notifications"
    },
    {
      "name": "webhook_events_filter",
      "type": "array",
      "required": false,
      "description": "Filter for webhook events: start, output, logs, completed"
    }
  ]
}