Skip to main content

​
Base URL

All API requests go to:
Every path in this reference is relative to that base.

​
Authentication

Chowder uses Bearer token authentication. Include your API key in the Authorization header on every request (except Signup, which doesn’t require auth).
There are two key types: You get an org key when you sign up. Scoped keys are created separately and are useful for giving external apps limited access to individual instances.

​
Content Type

All request and response bodies are JSON. Set the header:

​
Error Format

When something goes wrong, the API returns a JSON body with a detail field:
Some errors (like gateway proxy failures) return a nested object:

​
Status Codes

​
Rate Limits

There are no rate limits currently enforced. Be reasonable — we reserve the right to introduce limits in the future if needed.

​
Instance Lifecycle

When you create an instance, it goes through a provisioning phase (~90 seconds) where a cloud sandbox is spun up and configured. You can poll the status endpoint to know when it’s ready. Possible instance statuses: