ATLAS API reference
REST over HTTPS, JSON, OpenAPI 3.1.
The full reference, including request and response schemas, is at
docs.terravek.com/atlas/v3/. The OpenAPI 3.1 specification is published and may be
used to generate a client.
Authentication
OAuth 2.0 client credentials for machine-to-machine access; OIDC via
identity.terravek.com for interactive user access. Tokens are valid for 3,600
seconds — respect expires_in rather than assuming an hour.
Full detail.
Principal endpoints
| Method | Path | Purpose |
|---|---|---|
| POST | /v3/oauth/token | Obtain an access token |
| GET | /v3/collections | List STAC collections available to your tenancy |
| POST | /v3/search | STAC item search by bbox, datetime, and property filters |
| GET | /v3/items/{{id}} | Retrieve a single STAC item with asset links |
| POST | /v3/tasks/feasibility | Check acquisition feasibility before committing |
| POST | /v3/tasks | Submit an acquisition request |
| GET | /v3/tasks/{{id}} | Task status and state |
| GET | /v3/deliveries/{{id}} | Delivery metadata and quality report |
| POST | /v3/subscriptions | Create a webhook subscription |
| GET | /v3/nodes | List FIELDKIT nodes and their latest telemetry |
| GET | /v3/quality/{{delivery_id}} | ISO 19157 quality report for a delivery |
Task states
| State | Meaning |
|---|---|
SUBMITTED | Accepted, awaiting scheduling |
AWAITING_WINDOW | Scheduled, waiting for a feasible acquisition opportunity |
ACQUIRED | Acquisition made, processing |
ATTEMPTED_CLOUD | Acquisition made but rejected at quality control for cloud cover |
QUALITY_HOLD | Processed but below your contracted quality threshold; not auto-delivered |
DELIVERED | Available, with quality report |
CANCELLED | Cancelled by you or by Terravek |
Rate limits
Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and
X-RateLimit-Reset. Standard tier: 600 requests per minute, 200,000 per day.
Sandbox: 1,000 per day. A 429 includes Retry-After; please honour it.
Detail.
Versioning
The major version is in the path. No breaking changes are introduced within a major version. v2 is supported until 12 September 2026. Deprecation policy.
API support: api@terravek.com. For anything affecting production, open a support case rather than e-mailing — support options.