Getting started

This guide walks you through your first successful API call to Cosmos.

Prerequisites

An active Cosmos organization account

An API key (X-Ingest-Webhook-Secret) — provided by your Cosmos account manager during onboarding

A tool to make HTTP requests (cURL, Postman, or your integration platform)

Steps to get started

Verify your credentials

Send a minimal request to confirm your API key works:

Check the response

A successful response returns HTTP 200 with a results array:

{
  "results": [
    {
      "external_id": "test-001",
      "status": "success",
      "flight_leg_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ],
  "summary": {
    "total": 1,
    "succeeded": 1,
    "failed": 0
  }
}

TIP

Store the returned flight_leg_id– this is the Cosmos internal identifier for the flight leg you created.

Send updates

Cosmos uses a full-state replacement model. To update a flight leg, re-send the complete current state of the record using the same external_id.

See Idempotency & State management for details on how Cosmos handles updates, delay diffing, and nullable fields.

Prerequisites#

Steps to get started#

Prerequisites

Steps to get started