Renders

List renders

get/v1/renders

Request

  • Base URL: https://api-eu.dynamicdocumentapi.com
  • URL: https://api-eu.dynamicdocumentapi.com/v1/renders
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

batch_idstring
created[gte]string date-time
created[lte]string date-time
cursorstring
input_type'einvoice' | 'html' | 'markdown' | 'pdf_tool' | 'template' | 'url'
limitinteger

1 to 100 (default 50).

metadata[key]string

Filter by a metadata key/value.

output_format'html' | 'jpeg' | 'pdf' | 'png' | 'webp' | 'xml' | 'zip'
referencestring
sourcestring
'queued' | 'processing' | 'succeeded' | 'failed' | 'canceled' | 'expired'
OR
string[]

Repeat it (or comma-separate the values) to match any of several statuses.

template_idstring
testboolean

Response

has_moreboolean required
next_cursorstring nullable
object'list' required

Example response

{
  "data": [
    {
      "billed_renders": 1,
      "email": [
        {
          "error": {
            "code": "email_daily_cap_reached"
          },
          "id": "ems_01J9ZM1X3F7R8K2C4V6B8N0P2T",
          "rule_id": "emr_01J9ZK3M7Q8V5W2X4Y6Z8A0B1E"
        }
      ],
      "engine": "2026.4",
      "error": {
        "code": "template_runtime_error"
      },
      "files": [
        {
          "bytes": 48213,
          "content_type": "application/pdf",
          "filename": "invoice-42.pdf",
          "id": "file_01J9ZM1X3F7R8K2C4V6B8N0P2Q"
        }
      ],
      "id": "rnd_01J9ZM1X3F7R8K2C4V6B8N0P2Q",
      "kind": "pdf_template",
      "region": "eu",
      "result": {
        "conformance": {
          "einvoice": {
            "errors": [
              {
                "location": "invoice.seller.contact.email",
                "rule": "BR-DE-15"
              }
            ],
            "scenario": "EN16931 XRechnung (CII)",
            "validator": "KoSIT Validator 1.6.3",
            "warnings": [
              {
                "location": "invoice.seller.contact.email",
                "rule": "BR-DE-15"
              }
            ]
          },
          "pdfa": {
            "errors": [
              {
                "location": "invoice.seller.contact.email",
                "rule": "BR-DE-15"
              }
            ],
            "profile": "PDF/A-3B validation profile",
            "validator": "veraPDF 1.30.2",
            "warnings": [
              {
                "location": "invoice.seller.contact.email",
                "rule": "BR-DE-15"
              }
            ]
          },
          "pdfua": {
            "errors": [
              {
                "location": "invoice.seller.contact.email",
                "rule": "BR-DE-15"
              }
            ],
            "profile": "PDF/UA-1 validation profile",
            "validator": "veraPDF 1.30.2",
            "warnings": [
              {
                "location": "invoice.seller.contact.email",
                "rule": "BR-DE-15"
              }
            ]
          }
        }
      },
      "source": "api",
      "storage": [
        {
          "destination_id": "dst_01J9ZM1X3F7R8K2C4V6B8N0P2Q"
        }
      ],
      "timings": {
        "queued_ms": 3,
        "render_ms": 612,
        "total_ms": 681,
        "upload_ms": 38
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.