Developer docs

OpenAPI and tooling

Use the Redact PDF AI openapi.yaml as the source of truth: import it into Postman or your client generator, validate headers and test the full job flow.

OpenAPI and Tooling

Use the OpenAPI file as the canonical schema for endpoint details.

Why use OpenAPI first

  • Contract-first integration for backend teams
  • Source of truth for parameters and response schemas
  • Automatic SDK/client generation support

Suggested workflow

  1. Import openapi.yaml into your API client tool.
  2. Validate required headers (X-API-Key, optional X-Idempotency-Key).
  3. Test full flow: create job -> poll -> download -> delete.
  4. Add retry logic for 429 and 5xx.

Recommended tools

  • Postman (import OpenAPI)
  • Insomnia (import OpenAPI)
  • OpenAPI Generator for typed clients

Related pages