The Depot API is a collection of endpoints that grant access to the underlying architecture. The API uses Connect, offering multiprotocol support for gRPC and HTTP JSON.
Depot CI has its own API for working with workflows programmatically: dispatching and rerunning workflows, listing runs, checking status, fetching logs and metrics, retrying and cancelling jobs, and downloading artifacts. See the Depot CI API reference for all endpoints and examples.
Organizations can manage projects, acquire BuildKit endpoints, and run image builds for their applications or services programmatically. Depot provides the following SDKs for interacting with the container builds API:
For detailed documentation on all available endpoints, parameters, and examples, see the SDK Reference.
If you're using the container builds API to build untrusted code, you need one Depot project per customer entity in your organization. A separate project per customer ensures secure cache isolation so that one customer's build can't access another customer's build cache.
Authenticate to the API using an Authorization header with an Organization Token that you generate in your organization settings. See the Authentication docs for more details.