API Documentation

Overview

The Orbitex API lets you integrate compress, merge, split and convert operations into your own applications, scripts, and CI pipelines. All requests use HTTPS and require an API key.

The API is in development. Endpoints, rate limits, and authentication details will be published here before public beta.

Authentication

Requests include an Authorization header with your API key:

• Keys are created in your Orbitex dashboard (Business plan).
• Rotate keys from the dashboard if a key is compromised.
• Never expose keys in client-side JavaScript or public repositories.

Planned endpoints

The initial API surface will include:

• POST /v1/pdf/compress - Reduce PDF file size
• POST /v1/pdf/merge - Combine multiple PDFs
• POST /v1/pdf/split - Split by pages or ranges
• POST /v1/pdf/convert - PDF to Word, Excel, and back
• POST /v1/pdf/protect - Encrypt with a password
• GET /v1/jobs/{id} - Poll async job status

File handling

Uploaded files follow the same security and deletion rules as the web UI. See the File Security policy for retention windows and encryption details.

Webhooks will notify your server when long-running jobs complete.

Rate limits

Rate limits depend on plan tier. Free tier API access is not planned. Business customers receive documented limits and burst allowances.

Get early access

Tell us about your use case - batch conversion, document pipelines, SaaS integration - and we will notify you when the beta opens.