API quickstart

Base URL

Production API base: Provided in onboarding package (provided after tenant provisioning).

Sandbox base: Provided in onboarding package (provided with pilot intake approval).

Authentication

Issue a bearer credential in the portal Key Vault. Plaintext is shown once at issuance — copy immediately.

Include the credential in the Authorization header on every request.

Submit jobs

Ingestion job endpoints: Provided in onboarding package (see provisioning documentation).

Poll job status via the ingestion workspace or API status routes.

Usage and billing

View metered byte volume in the portal Usage Ledger and Billing workspace.

Export usage artifacts for invoice reconciliation.

Credential lifecycle

Rotate by generating a new credential and revoking the prior one.

Revoked credentials are purged from the vault; audit trail records the event.

Support

Account questions: Provided in onboarding package (support mailbox).

Billing: Provided in onboarding package (billing mailbox).

Auth header

Authorization: Bearer YOUR_API_KEY

Sample request

curl -X GET "Provided in onboarding package/api/v1/status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Sample response

{
  "status": "ok",
  "tenant": "Provided in onboarding package"
}