API Overview
Celeredge offers programmatic access to the platform. API access is a plan-gated capability — see Billing & Plans. This page covers the essentials; specific endpoints are documented alongside the features they power.
Authentication
Celeredge supports two ways to authenticate:
| Method | Used for | How |
|---|---|---|
| Session / Firebase identity | The web application | Handled automatically when you sign in |
| API key | Programmatic access | Send the header X-API-Key: <id>#<key> |
API keys are scoped (for example to a user or an agent), so a key carries only the access it was granted. Treat keys as secrets: store them securely, never commit them to source control, and rotate them if exposed.
Base URL
Use your environment's API base URL (your production tenant's API host). If you're unsure of the correct host for your firm, contact Celeredge support.
Conventions
- HTTPS only. All API traffic is over TLS.
- JSON request and response bodies.
- Scoped to your organization. Calls act within your firm's tenant and respect the same roles & permissions as the application.
- Engagement-scoped resources. Most resources hang off an engagement, mirroring the product model (see Core Concepts).
Quotas
API usage counts toward your plan's quotas (such as the AI token budget). A request that would exceed a hard quota is rejected with a clear limit response rather than partial work.
Getting help
The API surface evolves with the product. For the current endpoint catalog, authentication details for your environment, and access to API features on your plan, contact Celeredge support.