Welcome to the Adapter API
The Adapter API allows you to programmatically interact with your connected data sources. Query your data, manage connections, and build intelligent applications powered by concept understanding and knowledge graphs.
Base URL
All API requests should be made to:
https://api.adapter.com/v1
Authentication
All API endpoints require authentication using an API key in the Authorization header:
curl https://api.adapter.com/v1/connections \
-H "Authorization: Bearer ak_live_your_api_key_here"
Never expose your API keys in client-side code or public repositories. Always use environment variables.
API Keys & Permissions
API keys can have different permission levels:
- Read-Only: Can only query and retrieve data
- Write: Can query and modify data
- Full Access: Complete access including deleting connections
See the API Keys Guide for more information on creating and managing keys.
All responses are returned in JSON format:
{
"data": { ... },
"total": 10
}
Errors
The API uses standard HTTP status codes and returns error details in JSON:
{
"error": "unauthorized",
"message": "Invalid or missing API key",
"details": {
"code": "INVALID_KEY"
}
}
Common Status Codes
| Code | Description |
|---|
| 200 | Success |
| 201 | Created |
| 204 | No Content (successful deletion) |
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid or missing API key |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |
Rate Limits
API requests are rate-limited based on your plan:
| Plan | Requests/min | Requests/day |
|---|
| Free | 60 | 10,000 |
| Pro | 600 | 100,000 |
| Enterprise | Custom | Custom |
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1644249600
SDKs & Libraries
import { client, AdapterClient } from "@adapter/sdk";
client.setConfig({
baseUrl: "https://api.adapter.com",
headers: { Authorization: `Bearer ${process.env.ADAPTER_API_KEY}` },
});
const adapter = new AdapterClient();
const { data } = await adapter.listConnections();
OpenAPI Specification
View the full OpenAPI spec: openapi.json
Available Endpoints
Explore the API endpoints using the navigation on the left, or jump to:
