API & integration

OpenFormat is primarily delivered as a web application for interactive conversions. If you need automation, you can integrate at the deployment layer (for example, wrapping the same conversion services in your own API project) or extend this codebase with authenticated endpoints tailored to your organization.

Programmatic use cases

Typical patterns include batch jobs on a trusted worker, internal microservices that call shared conversion libraries, or a private gateway that accepts uploads from approved clients only.

Security considerations

Any programmatic surface that accepts arbitrary files should implement authentication, rate limits, virus scanning where appropriate, and strict file-type policies. Treat uploads as untrusted input even on an internal network.

Documentation

For interactive testing, start from the home catalog and pick a conversion route. When you add your own HTTP API, document request schemas, size limits, and error codes alongside your operational runbooks.