Skip to main content
The Ardent API lets you create projects, connect Postgres sources, create branches, poll long-running operations, and manage organization access from your own automation. Use the CLI for interactive setup and day-to-day terminal work. Use the API when you are building CI systems, internal developer platforms, custom dashboards, or agent workflows.

​
Base URL

All examples use JSON over HTTPS and assume your token is stored in ARDENT_TOKEN.

​
Authentication

Pass an API token with each request:
Create and revoke tokens in Ardent dashboard > Settings > API keys, or via the API keys endpoints. See Authentication for token handling, roles, and troubleshooting.

​
Resource model

  • Organization: your team and billing/security boundary.
  • Project: a workspace for related connectors and branches.
  • Connector: one Postgres source server that Ardent can replicate and branch.
  • Branch: an isolated database created from a connector.

​
A minimal API flow

  1. List or create a project.
  2. Preflight a Postgres source.
  3. Create a connector after preflight passes.
  4. Create a branch from the connector — this returns an operation ID.
  5. Poll the operation; when it completes, result.branch_url is the connection string for your app, test runner, or agent.
For Postgres branches, service_type is postgres — not the connector type postgresql. The create call returns 202 Accepted with an operation_id — see Branches for the full flow.

​
Long-running work

Some API calls return immediately with an operation ID while Ardent continues the work in the background. Connector discovery and setup are the most common examples.
See Operations for the full polling model.

​
Stability notes

Read the fields you need and ignore unknown ones — the API may add fields over time. Treat missing required fields, failed operations, and empty branch URLs as hard failures in automation. See Errors for status codes and retry guidance.