- REST: a standard HTTPS + JSON API you can use from any language or HTTP client.
- SDKs: official, fully typed client libraries generated from the same OpenAPI spec. The TypeScript SDK (
warp-hr) wraps authentication, pagination, retries, and error handling for you.
Base URL
Use the production API base URL for all requests:Get started
Quickstart
Make your first request over REST or with the TypeScript SDK.
Authentication
Authenticate requests with your company API key.
API reference
Explore generated endpoint documentation from Warp’s OpenAPI spec.
TypeScript SDK
Call the API with idiomatic, fully typed code.
How the docs are organized
The docs are split into three tabs:- Docs: orientation and the Quickstart to make your first request.
- API reference: conceptual guides (Authentication, Pagination, Rate limiting, and Errors) alongside the generated endpoint and webhook reference.
- SDKs: install and use the official TypeScript client library.
