Quickstart

Submit your first Data API request and retrieve its result.

1. Set your credentials

export RUNHARVESTER_API_KEY="rh_live_replace_me"
export RUNHARVESTER_API_BASE_URL="https://api.runharvester.com/api/v1/data"

Keep the key server-side. Do not put it in browser JavaScript or commit it to source control.

2. Submit a request

curl -X POST "$RUNHARVESTER_API_BASE_URL/requests" \
  -H "X-API-Key: $RUNHARVESTER_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: onboarding-example-001" \
  -d '{
    "url": "https://example.com",
    "proxy": "random",
    "mode": "auto"
  }'

The response includes a request ID and lifecycle state. Save the ID; it is the handle for polling and retrieval.

3. Poll, then retrieve

curl "$RUNHARVESTER_API_BASE_URL/requests/<request-id>" \
  -H "X-API-Key: $RUNHARVESTER_API_KEY"

curl "$RUNHARVESTER_API_BASE_URL/requests/<request-id>/result" \
  -H "X-API-Key: $RUNHARVESTER_API_KEY"

For production patterns, see validated results, retries, and the generated API reference.

Last updated on

Getting started

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

On this page

1. Set your credentials2. Submit a request3. Poll, then retrieve