Authentication

Authenticate requests with an API key or bearer token.

The public API accepts an API key in X-API-Key or a bearer token in Authorization.

X-API-Key: rh_live_replace_me
Authorization: Bearer rh_live_replace_me

Data API keys normally need scrape:write to submit work and requests:read to inspect jobs and results. Use the smallest scope set that supports the integration.

Some accounts require a verified email before public Data API use. Treat EMAIL_VERIFICATION_REQUIRED and EMAIL_NOT_VERIFIED as account-action errors, not transient request failures. See errors for the response shape.

The API playground makes direct browser requests to https://api.runharvester.com. If your account or browser environment reports a CORS failure, the API must allow the exact origin https://docs.runharvester.com; this portal does not proxy playground traffic.

Last updated on

Getting started

The shortest path from an API key to a reliable result.