REST API

The REST API is generated from the same OpenAPI document used to build the TypeScript SDK. Endpoint pages include authentication, parameters, request and response schemas, and an interactive request builder.

Base URL

https://api.alien.dev

Authentication

Send an Alien API key as a Bearer token:

curl "https://api.alien.dev/v1/projects?workspace=my-workspace" \
  -H "Authorization: Bearer $ALIEN_API_KEY"

Create keys with the smallest scope and role the integration requires. Keep them in server-side secret storage and never expose them to a browser.

Errors

API errors include a machine-readable code, human-readable message, retryability, request ID, and optional remediation hint. Include the request ID when contacting support.

Use the TypeScript SDK when you want generated request and response types, retries, and typed errors. The source document is available at /openapi.json.