Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.shipyard.lol/llms.txt

Use this file to discover all available pages before exploring further.

Console API keys are organization-scoped credentials for programmatic access. Keys are shown once when created, stored as hashes, and can be revoked from the dashboard.

Key lifecycle

1

Create a named key

Use a clear name such as CI, Production, or the integration name.
2

Store the secret immediately

The full key is only returned once. Save it in your secret manager.
3

Use bearer authentication

Send the key in the Authorization header.
4

Revoke stale keys

Remove keys that are unused, exposed, or owned by former teammates.
curl https://agents.shipyard.lol/api/v1/agents \
  -H "Authorization: Bearer sa_your_api_key"