Introduction to AntAPI
AntAPI operates APIs behind a single Gateway. Your application uses a project API key to call a published product, and paid operations draw from your organization's Credits balance.
Choose a product
Each product has its own URL prefix, request formats, response fields, and definition of a successful result. Start from the documentation home to choose a published product. Its integration guides explain the workflow; its API reference lists the exact published endpoints, schemas, and current prices.
The shared request pattern is:
<gateway-base-url>/<product-slug>/v1/<endpoint-path>
The official Gateway base URL is https://api.antapi.dev, separate from the public website and Console. All product requests, including free operations, go through this entry point.
Organize your integration
| Concept | Purpose |
|---|---|
| Organization | Owns the shared Credits balance and projects. |
| Project | Groups API keys and usage, with a UTC monthly budget. |
| API key | Authenticates product requests in a project. Keep it on your server. |
| Credits | Pay for published API operations according to their billing unit. |
| Receipt | Records an authoritative final paid settlement. |
Use Console to manage your organization, projects, keys, Credits, and usage. Console uses a session cookie; your backend calls product APIs with a project API key. You can read these public docs without signing in.
Understand the two execution patterns
Synchronous operations return their result in the response. A paid endpoint can charge per successful request or per verified successful item, as specified in its reference.
Asynchronous operations return an acceptance response, usually with a job identifier. You then read progress and results using the product's endpoints. HTTP 202 confirms acceptance; the final successful quantity and charge are determined later.
Before paid execution, the platform reserves the maximum authorized cost. It settles successful units and releases the unused reservation after verifying the outcome. Read Credits and billing for the shared rules, and the product guide for what counts as successful.
Start building
Follow the quickstart, then use authentication, safe retries, and error recovery as you prepare for production.