Introduction
Everything you need to integrate the Piloterr API into your application.
Get started with the Piloterr API in minutes. Make HTTP requests to our endpoints and receive structured JSON responses.
Quick Start
Get your API key
Sign up on your dashboard and copy your API key from the Settings page.
Make your first request
Include your key in the x-api-key header and call any endpoint:
curl "https://api.piloterr.com/v2/usage" \
-H "x-api-key: YOUR_API_KEY"Handle the response
Every successful request returns a JSON object with structured data. See individual endpoint pages for response schemas and examples.
Authentication
All API requests must include an x-api-key header. You can find your key in your dashboard → API Keys.
curl -H "x-api-key: xxxx" https://api.piloterr.com/v2/usageKeep your API key secret. Do not expose it in client-side code or public repositories.
Status Codes
Billing applies to successful requests: 200 for synchronous calls, 201 for asynchronous jobs. 404 billing varies by endpoint (check each endpoint page). All other 4xx/5xx responses are free.
| Code | Billed | Status | Action |
|---|---|---|---|
200 | Yes | Successful API Call | No action required. |
201 | Yes | Job Created | No action required. |
202 | No | Accepted (Async) | The request was accepted and is being processed. Use the job ID to check the status. |
400 | No | Bad Request | Verify your parameters and their types. Check the documentation for more information. |
401 | No | Invalid API Key | Check your API key (x-api-key header or x_api_key query string). |
401 | No | Inactive API Key | Activate your API key in the API Keys section of your account settings. |
401 | No | Expired API Key | Update your API key or generate a new one. |
401 | No | Rate limit exceeded | Back off and retry. Upgrade your plan or raise per-key quotas if this happens often. |
402 | No | Payment required | Top up credits, upgrade your plan, enable Auto Top-Up, or settle any open invoices. |
403 | No | Forbidden | Verify your permissions. Contact us if you believe this is a mistake. |
404 | Varies | Not Found | Billing is endpoint-specific. Check the individual endpoint documentation. |
413 | No | Payload Too Large | The uploaded file or request body exceeds the size limit. Check the API documentation for maximum sizes. |
500 | No | Internal Error | Retry the action or contact our support team. |
See the Credits page for a full breakdown per endpoint, API Keys for key management, and Best Practices and Error Handling for integration guidance. New to the platform? The Glossary defines all key terms.
Endpoints
Browse every endpoint in the API reference, or open one directly: