API

Overview

This reference documents every public route of the SHIP HTTP API, from the API's own definition.

The console uses this same API, so the API can do everything that the console does. The CLI uses the API too.

This section documents 98 public routes. The pages come from the API's own OpenAPI document and not from text that someone wrote by hand, so they describe the deployed routes.

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 tells you how to create a token, what each scope grants, and which scope sets to use for common integrations.

How is this page?

Command reference

This page lists every ship command and flag, from the CLI's own definition.

Authentication

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