Appliances Endpoints
Endpoints · OCR Extract v2.5.0
The endpoints this appliance exposes, with schemas and permission keys.
| Key | Method | Route | Mode | |
|---|---|---|---|---|
| extract | POST | /v1/extract | Sync | |
| status | GET | /v1/jobs/{id} | Sync | |
| batch | POST | /v1/batch | Async |
About this page
The service doors a version exposes — each with its contract. Products call these through the platform, which means every call is identity-checked and logged; an appliance never gets a private side channel into your data.
Behind this page/appliances/versions/:packageVersionId/endpoints · CanManageAppliances
Retrieve
Endpoint definitions read fromApplianceVersionEndpoints (key, method, route, I/O schemas, permission, timeout, mode).Save
Managed as part of the draft version throughsp_AppliancePkg_CreateVersion.Success
- Each endpoint carries a required permission key.
- Schemas are validated at publish.
- Runtime enforces the contract independently.
CLI handoff
Implement this scaffold from the structured contract, then remove hard-coded preview rows. The source of truth is CLI Handoff and admin-cli-manifest.json.
Page IDappliance-endpoints
Route/appliances/versions/:packageVersionId/endpoints
AccessCanManageAppliances
Statuscatalog-schema-ready-content-not-seeded
Server-inject identity and scope values; never trust browser-supplied account, app, tenant, user, entitlement, price, or permission identifiers. Preserve the loading, empty, forbidden, failed, retrying, and completed states shown by the preview.