> ## Documentation Index > Fetch the complete documentation index at: https://docs.enfinitos.com/llms.txt > Use this file to discover all available pages before exploring further. # Ingest an adapter batch > The integration-adapter bridge. Accepts the same canonical rows the substrate adapters emit (the frozen `runtime.event_ingest.v1` shape — campaignId, sessionId, siteId/deviceId + an events[] array) and translates each event onto the live, signed delivery path using the tenant's ingest mappings (see `/v1/delivery/mappings`): campaignId → rightId (campaign mapping, required); siteId, falling back to deviceId → spatialAnchorId (placement mapping, optional — the raw key is used when unmapped); event.meta duration (dwellMs | durationSeconds | spotLength | duration) → dwellMs. Spatial/AR-VR + satellite + screen telemetry rides in `event.meta.telemetry` (same shape as the `telemetry` object on `POST /v1/delivery`). Each event becomes one signed receipt. Individual rows can fail (unmapped campaign, inactive right, constraint violation) and are reported per row — the batch returns 200 with a results array, not all-or-nothing. Caps: 200 rows, 500 deliveries per batch. Requires scope `delivery:write`. ## OpenAPI ````yaml /openapi-v1.yaml post /v1/delivery/ingest-batch openapi: 3.1.0 info: title: EnfinitOS API version: v1.0 description: >- The governed-execution `/v1` developer API for EnfinitOS — rights, delivery, proof, and settlement. Use this API to register the legal **bases** a right rests on, **issue** and lifecycle-manage rights across delivery substrates (DOOH, CTV, spatial/AR, mobile, audio, and more), negotiate **offers**, raise and resolve **challenges**, observe constraint-gated **deliveries**, seal signed **proof packs**, read **metering** + **settlement** projections, configure settlement **rules** and **counterparties**, fulfil GDPR **compliance** requests, and subscribe to **webhooks**. Every state-changing action is appended to an immutable, signable audit log; delivery and proof artefacts are Ed25519-signed so a downstream auditor can verify them offline. ## Response envelope Every response wraps its payload in a canonical envelope. Success (HTTP 200): ```json { "ok": true, "data": { ... }, "contractVersion": "v1.0" } ``` Error (4xx / 5xx): ```json { "ok": false, "error": "VALIDATION_FAILED", "message": "human text", "contractVersion": "v1.0" } ``` Some error responses carry additional context fields alongside `error` and `message` (for example `field`, `validationErrors`, `requiredScopes`, `keyScopes`). ## Authentication All endpoints except `GET /v1` and `GET /v1/healthz` require an API key sent as `Authorization: Bearer `. Keys carry a set of named scopes; each operation documents the scope it requires. A key carrying the `*` wildcard scope passes every scope check. Pre-launch, sandbox keys are issued through the apply flow: request access at `/apply`, receive an activation email on approval, and exchange it for a `/v1` sandbox key in the integration playground at `/developers/playground`. Self-service key issuance from the developer dashboard at `/developers/dashboard` lands at the April 2027 production launch. ## Identifiers Resource ids are prefixed: bases `bas_…`, rights `rgh_…`, offers `ofr_…` (passed as `rightId`/`offerId`), settlement rules `rule_…`, counterparties `cp_…`, webhook subscriptions, and webhook deliveries `dlv_…`. All timestamps are ISO-8601 strings. contact: name: EnfinitOS Developer Support url: https://docs.enfinitos.com email: developers@enfinitos.com servers: - url: https://sandbox.api.enfinitos.com description: Sandbox — live today - url: https://api.enfinitos.com description: Production — at the April 2027 launch security: - bearerAuth: [] tags: - name: Discovery description: Unauthenticated contract + health probes. - name: Tenant description: Read the caller's sandbox tenant snapshot. - name: Rights description: Bases and the right lifecycle (issue, suspend, resume, revoke). - name: Offers description: Propose, accept, reject, counter, and withdraw offers. - name: Challenges description: Open, resolve, and withdraw challenges against rights. - name: Delivery description: Observe constraint-gated delivery events. - name: Audit description: The append-only event log. - name: Proof description: Signed proof packs. - name: Metering & Settlement description: Metering and settlement projections. - name: Settlement config description: Settlement rules and counterparties. - name: Compliance description: GDPR Article 15 export and Article 17 erasure. - name: Webhooks description: Webhook subscriptions and delivery history. - name: Disputes description: Delivery disputes — open, investigate, respond, resolve. paths: /v1/delivery/ingest-batch: post: tags: - Delivery summary: Ingest an adapter batch description: >- The integration-adapter bridge. Accepts the same canonical rows the substrate adapters emit (the frozen `runtime.event_ingest.v1` shape — campaignId, sessionId, siteId/deviceId + an events[] array) and translates each event onto the live, signed delivery path using the tenant's ingest mappings (see `/v1/delivery/mappings`): campaignId → rightId (campaign mapping, required); siteId, falling back to deviceId → spatialAnchorId (placement mapping, optional — the raw key is used when unmapped); event.meta duration (dwellMs | durationSeconds | spotLength | duration) → dwellMs. Spatial/AR-VR + satellite + screen telemetry rides in `event.meta.telemetry` (same shape as the `telemetry` object on `POST /v1/delivery`). Each event becomes one signed receipt. Individual rows can fail (unmapped campaign, inactive right, constraint violation) and are reported per row — the batch returns 200 with a results array, not all-or-nothing. Caps: 200 rows, 500 deliveries per batch. Requires scope `delivery:write`. operationId: ingestDeliveryBatch requestBody: required: true content: application/json: schema: type: object required: - rows properties: rows: type: array minItems: 1 maxItems: 200 description: >- Canonical adapter ingest bodies (1-200 rows, at most 500 deliveries total). items: type: object required: - campaignId - events properties: campaignId: type: string description: >- Vendor campaign/deal/line-item id — resolved to a rightId via a campaign mapping. sessionId: type: string description: >- Optional vendor session id — becomes the receipt correlationId (`sessionId#eventIndex`). siteId: type: string description: >- Vendor site/venue/frame id — resolved to a spatialAnchorId (used raw when unmapped). deviceId: type: string description: >- Vendor device/player id — placement fallback when siteId is absent. events: type: array minItems: 1 items: type: object properties: event: type: string description: Vendor event kind (opaque). ts: type: string description: Vendor timestamp (opaque). meta: type: object description: >- Vendor metadata. Duration is derived from dwellMs | durationSeconds | spotLength | duration; an optional `telemetry` object (same shape as the POST /v1/delivery telemetry) is passed to the constraint gate. additionalProperties: true defaultDwellMs: type: integer minimum: 0 description: >- Optional fallback dwell (ms) when a row's event.meta carries no derivable duration — set it to the contracted spot length for feeds that omit per-event durations. responses: '200': description: >- Per-(row,event) results + a batch summary. Row failures are reported inline, not as an HTTP error. content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: type: object properties: results: type: array items: type: object properties: ok: type: boolean rowIndex: type: integer eventIndex: type: integer description: '-1 for row-level failures.' correlationId: type: string receipt: $ref: '#/components/schemas/ProofReceiptPayload' substrate: $ref: '#/components/schemas/Substrate' error: type: string description: >- Per-row failure code — VALIDATION_FAILED, UNMAPPED_CAMPAIGN, MISSING_PLACEMENT, RESOURCE_NOT_FOUND, PRECONDITION_FAILED, STATE_CONFLICT or INTERNAL_ERROR. message: type: string sessionId: type: string summary: type: object properties: received: type: integer accepted: type: integer rejected: type: integer '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '413': $ref: 24fa2682-dce8-4fef-9b06-b0f656ae93ff '422': $ref: '#/components/responses/ValidationFailed' components: schemas: SuccessEnvelope: type: object required: - ok - data - contractVersion properties: ok: type: boolean const: true data: description: Route-specific payload. Operation responses refine this. type: object contractVersion: type: string const: v1.0 ProofReceiptPayload: type: object description: The exact signed receipt payload the platform emits (version "1"). properties: version: type: string const: '1' receiptId: type: string correlationId: type: - string - 'null' spatialAnchorId: type: string spatialPlacementId: type: - string - 'null' issuedAt: type: string format: date-time renderedAt: type: string format: date-time dwellMs: type: number nonce: type: string witness: type: - string - 'null' Substrate: type: string description: >- Delivery substrate. The platform runtime recognises every value; which ones ship a dedicated client SDK varies (see the substrate readiness matrix). `ANY` matches all substrates. enum: - DOOH - CTV - MOBILE - STREAMING - AUDIO - MESSAGING - GAMING - GLASSES - AR_CONTACTS - HUD - VOLUMETRIC - HOLOGRAM - WEARABLES - AMBIENT - NEURAL - AUTOMOTIVE - SMART_HOME - ROBOTICS - DRONE - SATELLITE - AVIATION - MARITIME - SOCIAL_FEED - ANY ErrorEnvelope: type: object required: - ok - error - message properties: ok: type: boolean const: false error: $ref: '#/components/schemas/ErrorCode' message: type: string description: Human-readable explanation. contractVersion: type: string const: v1.0 field: type: string description: Present on some VALIDATION_FAILED errors — the offending field. validationErrors: type: array description: Present on settlement-rule / counterparty validation failures. items: type: object additionalProperties: true requiredScopes: type: array description: Present on SCOPE_MISSING — the scopes the operation needs. items: type: string keyScopes: type: array description: Present on SCOPE_MISSING — the scopes the presented key carries. items: type: string additionalProperties: true ErrorCode: type: string description: Machine-readable error code. Drives the HTTP status. enum: - AUTH_REQUIRED - AUTH_INVALID - SCOPE_MISSING - BAD_REQUEST - VALIDATION_FAILED - RESOURCE_NOT_FOUND - STATE_CONFLICT - PRECONDITION_FAILED - RATE_LIMITED - INTERNAL_ERROR responses: Unauthorized: description: >- Missing/malformed Authorization header (AUTH_REQUIRED) or an invalid key (AUTH_INVALID). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: >- The key is valid but missing one or more required scopes (SCOPE_MISSING). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' ValidationFailed: description: >- A field was missing or wrong-typed (VALIDATION_FAILED). May carry `field` or `validationErrors`. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: bearerAuth: type: http scheme: bearer description: 'API key sent as `Authorization: Bearer `.' ````