Using the API

Making Requests

This page shows complete request/response examples for the core Extralt API workflows.

Setup

export EXTRALT_API_KEY="your-api-key"
export BASE_URL="https://api.extralt.com"

Create a robot build

curl -s -X POST "$BASE_URL/robot-builds" \
  -H "Authorization: Bearer $EXTRALT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example-store.com/products/sample",
    "country": "US"
  }' | jq

Response:

{
  "_id": "bld_xyz789",
  "status": "pending",
  "url": "https://example-store.com/products/sample",
  "country": "US"
}

Get run status

curl -s "$BASE_URL/runs/$RUN_ID" \
  -H "Authorization: Bearer $EXTRALT_API_KEY" | jq

Response:

{
  "_id": "run_def456",
  "status": "running",
  "robotId": "rbt_abc123",
  "extractedCount": 42,
  "queueSize": 158
}

List captures

curl -s "$BASE_URL/captures?runId=$RUN_ID" \
  -H "Authorization: Bearer $EXTRALT_API_KEY" | jq

Response:

[
  {
    "_id": "cap_abc123",
    "url": "https://example-store.com/products/sneakers",
    "data": {
      "title": "Air Max 90",
      "brand": "Nike",
      "description": "Classic sneaker...",
      "variants": [
        {
          "option_values": ["10"],
          "price": { "amount": 130, "currency": "USD" },
          "availability": "in_stock"
        }
      ]
    }
  }
]

What's next