Skip to content
Ocean6Documentation
DocsProtocol
Proposed specificationUpdated 19 Sep 2026

API design reference

On this page
Design status

This chapter specifies proposed network behavior. It is not a deployed service or a production API contract.

The paths below define an interface review surface. No production host, access token flow or callable Ocean6 network API is supplied by this release. An integration release must publish its OpenAPI contract, authentication process, limits and compatibility policy together.

Swipe or scroll to view all columns →

Operation and proposed pathSuccess semantics
POST /v1/tasks202: request admitted; returns a task identifier and state, not execution success
GET /v1/tasks/{id}200: authorized state snapshot with a state version
POST /v1/tasks/{id}/cancel202: request recorded; 200 may return a previously recorded decision
GET /v1/tasks/{id}/events200: ordered events with an opaque continuation cursor
GET /v1/tasks/{id}/deliveries200: authorized delivery metadata; object access remains separately controlled
POST /v1/providers/nodes202: registration under review, not scheduling eligibility
POST /v1/attempts/{id}/receipt201: newly stored receipt; 200: an identical previously stored receipt

Transport and request controls#

API-01 Public transport MUST authenticate the service and protect credentials in transit. The server MUST validate content type, parse limits, nesting depth and duplicate JSON member names before applying business rules. Unknown fields or unsupported versions must produce explicit errors.

API-02 State-changing operations MUST enforce authorization and a defined concurrency policy. Task creation uses idempotency; receipt submission uses delivery identity and the active lease generation. A request identifier supports support and audit correlation without exposing credentials.

Pagination and asynchronous delivery#

Event cursors are opaque and bound to the authorized stream. The contract must document cursor expiry, ordering and recovery from an expired cursor. Clients should reconcile a snapshot and resume events without treating repeated notifications as new work.

Webhooks, if introduced, require destination validation, signed payloads, event identifiers, retry limits and a replay window. A receiver acknowledges durable receipt before asynchronous processing. Callback delivery order is not a substitute for the event stream's sequence.

Documentation 1.1 · Software reference 0.2
Download PDFDeveloper packageWord editionView Markdown

Search across all 30 chapters.

Use Tab to navigate results and Enter to open a chapter.
Documentation v1.1 · EN
Open task lab ↗Ocean6 website ↗