API

Overview

The platform's HTTP API. Every public route, generated from the API's own definition.

Everything the console does, the API does. It is the same surface, and the CLI is one of its consumers. 64 public routes are documented here, generated from the API's own OpenAPI document so they describe what is deployed rather than what was last written down.

Every route takes a personal access token as a bearer credential:

curl -H "authorization: Bearer $SHIP_API_TOKEN" https://api.letsship.ai/v1/missions

Authentication covers creating a token, what each scope grants, and the scope sets worth using for common integrations.

How is this page?

Command reference

Every ship command, every flag, generated from the CLI's own definition.

Authentication

Create a token, choose what it may do, and pick the scope set that fits your integration.