RoofKit
Developer docsPartner API
API keys

Export report

Generates a report export from the requested revision, or from the approved/current fallback revision when revision_id is omitted. PDF exports require `reports.export_pdf`; technical formats require `reports.export_technical`.

Bearer API key · Scope: reports.write

Endpoint

POST/api/v1/reports/{report_id}/export
Request bodyrequired
application/json
ReportExportRequest
Path parameters1 parameter
  • report_idrequired
    string

Headers1 parameter
  • Idempotency-Keyrequired
    string

Responses

201Export artifacts created.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
  • Idempotency-ReplayedPresent and true when a stored successful write response was replayed.
application/json
ReportExportResponse
400Request payload, query, or required header is invalid.
application/json
ErrorResponse
401Missing, malformed, revoked, deleted, or unknown API key.

Headers

  • WWW-AuthenticateDocumented response header
application/json
ErrorResponse
403API key lacks the required scope or the workspace is not active.
application/json
ErrorResponse
404Resource not found in the key-bound workspace.
application/json
ErrorResponse
409Request conflicts with idempotency or external event identity.
application/json
ErrorResponse
429Rate limit exceeded for this key and endpoint or invalid-auth bucket.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
  • Retry-AfterSeconds until the caller should retry.
application/json
ErrorResponse
500Internal authentication or server error.
application/json
ErrorResponse
Try it out
Path parameters
Headers