{
  "openapi": "3.1.0",
  "info": {
    "title": "MostlyRender API",
    "version": "1.0.0",
    "description": "Generate images, PDFs, and screenshots from templates — REST API with Bearer API keys."
  },
  "servers": [
    {
      "url": "https://api.mostlyrender.com"
    }
  ],
  "tags": [
    {
      "name": "Renders"
    },
    {
      "name": "Screenshots"
    },
    {
      "name": "Templates"
    },
    {
      "name": "Account"
    },
    {
      "name": "Render by URL"
    }
  ],
  "paths": {
    "/v1/renders": {
      "post": {
        "operationId": "createRender",
        "tags": [
          "Renders"
        ],
        "summary": "Render a template",
        "description": "Render a template to an image or PDF. Returns the stored asset `{ id, url }` synchronously. Pass `async: true` (or a `webhookUrl`) to enqueue the job instead and receive `202 { id, status }` — poll `GET /v1/renders/{id}` or receive a signed webhook when it finishes.",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Render completed.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "url",
                    "output"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Render id (also the stored asset name).",
                      "example": "rnd_abc123"
                    },
                    "url": {
                      "type": "string",
                      "format": "uri",
                      "description": "Public URL of the generated asset.",
                      "example": "https://img.mostlyrender.com/mostlyrender/renders/rnd_abc123.png"
                    },
                    "output": {
                      "type": "string",
                      "enum": [
                        "png",
                        "jpeg",
                        "webp",
                        "pdf"
                      ],
                      "default": "png",
                      "description": "Output format. PDF is vector; png/jpeg/webp are raster."
                    }
                  }
                },
                "example": {
                  "id": "rnd_abc123",
                  "url": "https://img.mostlyrender.com/mostlyrender/renders/rnd_abc123.png",
                  "output": "png"
                }
              }
            }
          },
          "202": {
            "description": "Async job accepted.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "status"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "job_xyz789"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "queued"
                      ],
                      "example": "queued"
                    }
                  }
                },
                "example": {
                  "id": "job_xyz789",
                  "status": "queued"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request (e.g. missing template).",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "templateId is required."
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid API key.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "invalid or revoked API key"
                }
              }
            }
          },
          "402": {
            "description": "Free-plan render quota exceeded — upgrade to keep rendering.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "You've used your renders quota on the free plan. Upgrade to keep rendering."
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "template"
                ],
                "properties": {
                  "template": {
                    "type": "string",
                    "description": "Template id to render. (`templateId` is also accepted.)",
                    "example": "tpl_abc"
                  },
                  "modifications": {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "Layer overrides keyed by layer name — **the layer name *is* the API parameter**. A string sets a text layer's text or an image layer's `src`; an object merges into the layer.",
                    "example": {
                      "title": "Renders that never go dark",
                      "theme": "dusk"
                    }
                  },
                  "output": {
                    "type": "string",
                    "enum": [
                      "png",
                      "jpeg",
                      "webp",
                      "pdf"
                    ],
                    "default": "png",
                    "description": "Output format. PDF is vector; png/jpeg/webp are raster."
                  },
                  "async": {
                    "type": "boolean",
                    "default": false,
                    "description": "Enqueue instead of rendering inline; responds `202`."
                  },
                  "webhookUrl": {
                    "type": "string",
                    "format": "uri",
                    "description": "Signed POST on completion (implies async)."
                  }
                }
              },
              "example": {
                "template": "tpl_abc",
                "modifications": {
                  "title": "Renders that never go dark"
                },
                "output": "png"
              }
            }
          }
        }
      }
    },
    "/v1/renders/batch": {
      "post": {
        "operationId": "createRenderBatch",
        "tags": [
          "Renders"
        ],
        "summary": "Render many in one call",
        "description": "Render up to 50 images in a single request (concurrency-capped, metered per item). Provide either a heterogeneous `renders: [...]` array, or one `template` plus an `items: [...]` array of modifications.",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Per-item results (failures are reported inline, not fatal).",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "results",
                    "count",
                    "ok"
                  ],
                  "properties": {
                    "results": {
                      "type": "array",
                      "items": {
                        "oneOf": [
                          {
                            "type": "object",
                            "required": [
                              "id",
                              "url",
                              "output"
                            ],
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "Render id (also the stored asset name).",
                                "example": "rnd_abc123"
                              },
                              "url": {
                                "type": "string",
                                "format": "uri",
                                "description": "Public URL of the generated asset.",
                                "example": "https://img.mostlyrender.com/mostlyrender/renders/rnd_abc123.png"
                              },
                              "output": {
                                "type": "string",
                                "enum": [
                                  "png",
                                  "jpeg",
                                  "webp",
                                  "pdf"
                                ],
                                "default": "png",
                                "description": "Output format. PDF is vector; png/jpeg/webp are raster."
                              }
                            }
                          },
                          {
                            "type": "object",
                            "required": [
                              "error"
                            ],
                            "properties": {
                              "error": {
                                "type": "string",
                                "description": "Human-readable error message."
                              }
                            }
                          }
                        ]
                      }
                    },
                    "count": {
                      "type": "integer",
                      "description": "Total items processed."
                    },
                    "ok": {
                      "type": "integer",
                      "description": "Items that succeeded."
                    }
                  }
                },
                "example": {
                  "results": [
                    {
                      "id": "rnd_1",
                      "url": "https://img.mostlyrender.com/mostlyrender/renders/rnd_1.png",
                      "output": "png"
                    },
                    {
                      "error": "render failed"
                    }
                  ],
                  "count": 2,
                  "ok": 1
                }
              }
            }
          },
          "400": {
            "description": "No items, or batch too large (max 50).",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "Batch too large (51); max 50."
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid API key.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "invalid or revoked API key"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "description": "One of the two batch shapes.",
                "anyOf": [
                  {
                    "required": [
                      "renders"
                    ],
                    "properties": {
                      "renders": {
                        "type": "array",
                        "maxItems": 50,
                        "items": {
                          "type": "object",
                          "properties": {
                            "template": {
                              "type": "string"
                            },
                            "modifications": {
                              "type": "object",
                              "additionalProperties": true,
                              "description": "Layer overrides keyed by layer name — **the layer name *is* the API parameter**. A string sets a text layer's text or an image layer's `src`; an object merges into the layer.",
                              "example": {
                                "title": "Renders that never go dark",
                                "theme": "dusk"
                              }
                            },
                            "output": {
                              "type": "string",
                              "enum": [
                                "png",
                                "jpeg",
                                "webp",
                                "pdf"
                              ],
                              "default": "png",
                              "description": "Output format. PDF is vector; png/jpeg/webp are raster."
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "required": [
                      "template",
                      "items"
                    ],
                    "properties": {
                      "template": {
                        "type": "string"
                      },
                      "output": {
                        "type": "string",
                        "enum": [
                          "png",
                          "jpeg",
                          "webp",
                          "pdf"
                        ],
                        "default": "png",
                        "description": "Output format. PDF is vector; png/jpeg/webp are raster."
                      },
                      "items": {
                        "type": "array",
                        "maxItems": 50,
                        "items": {
                          "type": "object"
                        },
                        "description": "Each item is a modifications object, or `{ modifications, output }`."
                      }
                    }
                  }
                ]
              },
              "example": {
                "template": "tpl_abc",
                "output": "png",
                "items": [
                  {
                    "title": "One"
                  },
                  {
                    "title": "Two"
                  },
                  {
                    "title": "Three"
                  }
                ]
              }
            }
          }
        }
      }
    },
    "/v1/renders/{id}": {
      "get": {
        "operationId": "getRenderJob",
        "tags": [
          "Renders"
        ],
        "summary": "Poll an async job",
        "description": "Fetch the status (and result, once done) of an async render/screenshot job.",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Job status.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "status"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "job_xyz789"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "queued",
                        "processing",
                        "done",
                        "error"
                      ]
                    },
                    "kind": {
                      "type": "string",
                      "enum": [
                        "render",
                        "screenshot"
                      ]
                    },
                    "result": {
                      "allOf": [
                        {
                          "type": "object",
                          "required": [
                            "id",
                            "url",
                            "output"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Render id (also the stored asset name).",
                              "example": "rnd_abc123"
                            },
                            "url": {
                              "type": "string",
                              "format": "uri",
                              "description": "Public URL of the generated asset.",
                              "example": "https://img.mostlyrender.com/mostlyrender/renders/rnd_abc123.png"
                            },
                            "output": {
                              "type": "string",
                              "enum": [
                                "png",
                                "jpeg",
                                "webp",
                                "pdf"
                              ],
                              "default": "png",
                              "description": "Output format. PDF is vector; png/jpeg/webp are raster."
                            }
                          }
                        }
                      ],
                      "nullable": true,
                      "description": "Present once `status` is `done`."
                    },
                    "error": {
                      "type": "string",
                      "nullable": true,
                      "description": "Present once `status` is `error`."
                    },
                    "created_at": {
                      "type": "string",
                      "format": "date-time",
                      "nullable": true
                    }
                  }
                },
                "example": {
                  "id": "job_xyz789",
                  "status": "done",
                  "kind": "render",
                  "result": {
                    "id": "rnd_abc",
                    "url": "https://img.mostlyrender.com/mostlyrender/renders/rnd_abc.png",
                    "output": "png"
                  },
                  "error": null
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid API key.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "invalid or revoked API key"
                }
              }
            }
          },
          "404": {
            "description": "Job not found (or not yours).",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "job not found"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "Job id from a `202` response.",
            "schema": {
              "type": "string",
              "description": "Job id from a `202` response.",
              "example": "job_xyz789"
            }
          }
        ]
      }
    },
    "/v1/screenshots": {
      "post": {
        "operationId": "createScreenshot",
        "tags": [
          "Screenshots"
        ],
        "summary": "Screenshot a URL",
        "description": "Capture any public web page as an image or PDF. Private/internal hosts are rejected (SSRF-guarded, including on redirects). Supports the same `async`/`webhookUrl` flow as renders.",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Screenshot completed.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "url",
                    "output"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Render id (also the stored asset name).",
                      "example": "rnd_abc123"
                    },
                    "url": {
                      "type": "string",
                      "format": "uri",
                      "description": "Public URL of the generated asset.",
                      "example": "https://img.mostlyrender.com/mostlyrender/renders/rnd_abc123.png"
                    },
                    "output": {
                      "type": "string",
                      "enum": [
                        "png",
                        "jpeg",
                        "webp",
                        "pdf"
                      ],
                      "default": "png",
                      "description": "Output format. PDF is vector; png/jpeg/webp are raster."
                    }
                  }
                },
                "example": {
                  "id": "shot_abc123",
                  "url": "https://img.mostlyrender.com/mostlyrender/screenshots/shot_abc123.png",
                  "output": "png"
                }
              }
            }
          },
          "202": {
            "description": "Async job accepted.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "status"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "job_xyz789"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "queued"
                      ],
                      "example": "queued"
                    }
                  }
                },
                "example": {
                  "id": "job_xyz789",
                  "status": "queued"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or disallowed URL (SSRF guard).",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "URL not allowed."
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid API key.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "invalid or revoked API key"
                }
              }
            }
          },
          "402": {
            "description": "Free-plan quota exceeded.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "You've used your renders quota on the free plan. Upgrade to keep rendering."
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "url"
                ],
                "properties": {
                  "url": {
                    "type": "string",
                    "format": "uri",
                    "description": "Public http(s) URL to capture.",
                    "example": "https://stripe.com"
                  },
                  "width": {
                    "type": "integer",
                    "default": 1200,
                    "minimum": 16,
                    "maximum": 2400
                  },
                  "height": {
                    "type": "integer",
                    "default": 630,
                    "minimum": 16,
                    "maximum": 2400
                  },
                  "fullPage": {
                    "type": "boolean",
                    "default": false,
                    "description": "Capture the full scroll height."
                  },
                  "scale": {
                    "type": "number",
                    "default": 1,
                    "maximum": 3,
                    "description": "Device scale factor (retina)."
                  },
                  "output": {
                    "type": "string",
                    "enum": [
                      "png",
                      "jpeg",
                      "webp",
                      "pdf"
                    ],
                    "default": "png",
                    "description": "Output format. PDF is vector; png/jpeg/webp are raster."
                  },
                  "async": {
                    "type": "boolean",
                    "default": false
                  },
                  "webhookUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              },
              "example": {
                "url": "https://stripe.com",
                "fullPage": true,
                "output": "png"
              }
            }
          }
        }
      }
    },
    "/v1/templates": {
      "get": {
        "operationId": "listTemplates",
        "tags": [
          "Templates"
        ],
        "summary": "List templates",
        "description": "List the templates in the authenticated account (most-recently-updated first, up to 200). Doubles as an API-key check.",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Your templates.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "templates"
                  ],
                  "properties": {
                    "templates": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "tpl_abc"
                          },
                          "name": {
                            "type": "string",
                            "example": "Launch card"
                          },
                          "width": {
                            "type": "integer",
                            "example": 1200
                          },
                          "height": {
                            "type": "integer",
                            "example": 630
                          },
                          "engine": {
                            "type": "string",
                            "enum": [
                              "layers",
                              "html"
                            ],
                            "example": "layers"
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "templates": [
                    {
                      "id": "tpl_abc",
                      "name": "Launch card",
                      "width": 1200,
                      "height": 630,
                      "engine": "layers"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid API key.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "invalid or revoked API key"
                }
              }
            }
          }
        }
      }
    },
    "/v1/account": {
      "get": {
        "operationId": "getAccount",
        "tags": [
          "Account"
        ],
        "summary": "Get the connected account",
        "description": "Return the account behind the API key — its plan and identity. Used by SDKs/Zapier to validate a key and label a connection.",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "The connected account.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "plan": {
                      "type": "string",
                      "example": "free"
                    },
                    "email": {
                      "type": "string",
                      "nullable": true,
                      "format": "email",
                      "example": "user@example.com"
                    },
                    "display_name": {
                      "type": "string",
                      "nullable": true,
                      "example": "Ada Lovelace"
                    }
                  }
                },
                "example": {
                  "plan": "free",
                  "email": "user@example.com",
                  "display_name": "Ada Lovelace"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid API key.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "error"
                  ],
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Human-readable error message."
                    }
                  }
                },
                "example": {
                  "error": "invalid or revoked API key"
                }
              }
            }
          }
        }
      }
    },
    "/v1/templates/{id}/render.{ext}": {
      "get": {
        "operationId": "renderByUrl",
        "tags": [
          "Render by URL"
        ],
        "summary": "Signed render-on-the-fly",
        "description": "Render a template directly from a signed URL — no API key, perfect for `<img>`/OG tags. The owner pre-signs the URL, so it **always serves** (it never blocks on quota the way the API does); repeat hits are CDN-cached and deduped from metering. Build these with the SDK's URL signer. Modifications are passed as query params; `sig`, `scale`, and `q` are reserved.",
        "security": [
          {
            "signature": []
          }
        ],
        "responses": {
          "200": {
            "description": "The rendered asset (binary).",
            "content": {
              "image/png": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "402": {
            "description": "The template owner's quota is exceeded.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "403": {
            "description": "Missing or invalid signature.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "Template not found.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "Template id.",
            "schema": {
              "type": "string",
              "description": "Template id.",
              "example": "tpl_abc"
            }
          },
          {
            "name": "ext",
            "in": "path",
            "required": true,
            "description": "Output extension.",
            "schema": {
              "type": "string",
              "enum": [
                "png",
                "jpg",
                "jpeg",
                "webp",
                "pdf"
              ],
              "description": "Output extension.",
              "pattern": "png|jpe?g|webp|pdf"
            }
          },
          {
            "name": "sig",
            "in": "query",
            "required": true,
            "description": "HMAC-SHA256 signature over the template, ext, and canonicalised params.",
            "schema": {
              "type": "string",
              "description": "HMAC-SHA256 signature over the template, ext, and canonicalised params."
            }
          },
          {
            "name": "scale",
            "in": "query",
            "required": false,
            "description": "Device scale factor.",
            "schema": {
              "type": "number",
              "maximum": 3,
              "description": "Device scale factor."
            }
          },
          {
            "name": "q",
            "in": "query",
            "required": false,
            "description": "JPEG/WebP quality.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 100,
              "description": "JPEG/WebP quality."
            }
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Your API key as a Bearer token: `Authorization: Bearer mr_live_…` (create one in the app → Settings)."
      },
      "signature": {
        "type": "apiKey",
        "in": "query",
        "name": "sig",
        "description": "HMAC-SHA256 signature for the public render-by-URL path (generated by the SDK URL signer)."
      }
    }
  },
  "webhooks": {
    "renderCompleted": {
      "post": {
        "summary": "Async job completed",
        "description": "When you supply a `webhookUrl`, MostlyRender POSTs here once the job finishes. The body is signed with HMAC-SHA256 in the `x-mostlyrender-signature: sha256=…` header (verify it with your signing secret).",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "example": "job_xyz789"
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "done",
                      "error"
                    ]
                  },
                  "result": {
                    "type": "object",
                    "nullable": true
                  },
                  "error": {
                    "type": "string",
                    "nullable": true
                  }
                }
              },
              "example": {
                "id": "job_xyz789",
                "status": "done",
                "result": {
                  "id": "rnd_abc",
                  "url": "https://img.mostlyrender.com/mostlyrender/renders/rnd_abc.png",
                  "output": "png"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledged (any 2xx)."
          }
        }
      }
    }
  }
}
