Voyage assessments

Create voyage assessment batch

Validates and enqueues one batch of voyage routes. The per-batch cap is entitlement-specific — read live_max_routes / test_max_routes from GET /api/v1/usage rather than assuming a number. Self-serve keys carry 10. Only accepted route items reserve quota.

Required scope: voyage:score.

post/api/v1/voyage-assessment-batches

Request

  • Base URL: https://arcnautical.com
  • URL: https://arcnautical.com/api/v1/voyage-assessment-batches
  • Auth: one of:
    • HTTP bearer
    • API key in header X-ArcNautical-Key

Headers

Idempotency-Keystring required

Required for resource-creating POST requests. The same key and identical body replay the original response for 24 hours; a different body returns idempotency_conflict.

Request body

customer_referencestring

Your label for the whole submission. Used as the default reference for any route that does not carry its own, so it comes back on each batch item and on the assessment behind it — GET /api/v1/voyage-assessments?customer_reference=<value> then returns everything this batch produced. A route-level customer_reference always wins over this one.

Response

Batch accepted for processing.

idstring required
status'queued' | 'completed' required
total_countinteger required
accepted_countinteger required
failed_countinteger required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.