Skip to main content
GET
https://api.getcatalog.ai
/
v2
/
extract
/
{execution_id}
cURL
# Check execution status (urls input)
curl -X GET "https://api.getcatalog.ai/v2/extract/extract-urls-965b1912-6af0-4ed8-b7e3-184b85e788b7" \
  -H "x-api-key: $CATALOG_API_KEY"


# Get results with pagination
curl -X GET "https://api.getcatalog.ai/v2/extract/extract-urls-965b1912-6af0-4ed8-b7e3-184b85e788b7?page=1&page_size=50" \
  -H "x-api-key: $CATALOG_API_KEY"

{
  "execution_id": "extract-urls-b45c2d8c-46b7-46c2-8fed-fa3788c75e2a",
  "status": "completed",
  "error": null,
  "meta": {
    "progress": {
      "products_processed": 1,
      "products_total": 1,
      "percent_complete": 100
    },
    "start_date": "2026-01-28T22:30:05.823Z",
    "stop_date": "2026-01-28T22:35:31.082Z",
    "duration_ms": 325259,
    "result": {
      "products_requested": 1,
      "products_successful": 1,
      "products_failed": 0
    },
    "credits_used": 5
  },
  "data": [
    {
      "url": "https://www.nike.com/t/air-force-1-07-mens-shoes-5QFp5Z/CW2288-111",
      "product": {
        "id": "6e6bd7bd-bfb5-4e05-85ee-4969628e741a",
        "title": "Nike Air Force 1 '07",
        "description": "Comfortable, durable and timeless—it’s number one for a reason. ...",
        "vendor": "nike.com",
        "brand": "Nike",
        "url": "https://www.nike.com/t/air-force-1-07-mens-shoes-5QFp5Z/CW2288-111",
        "handle": "cw2288-111",
        "is_available": true,
        "attributes": null,
        "price": { "current_value": 115, "compare_at_value": 115, "currency": "USD" },
        "images": [
          {
            "url": "https://static.nike.com/a/images/t_default/.../AIR+FORCE+1+%2707.png",
            "alt_text": "Nike Air Force 1 '07 product image (primary)",
            "position": 1,
            "width": 400,
            "height": 400,
            "id": "img-1769639694151-0",
            "variant_ids": ["variant-1769639694153-0", "_truncated"],
            "attributes": null
          },
          { "_truncated": "Additional image objects omitted for display" }
        ],
        "options": [
          { "name": "Color", "position": 1, "values": ["White/White"] },
          { "name": "Size", "position": 2, "values": ["6", "6.5", "7", "_truncated", "18"] }
        ],
        "variants": [
          {
            "id": "variant-1769639694153-0",
            "title": "Nike Air Force 1 '07 - White/white - 6",
            "is_available": true,
            "price": { "current_value": 115, "compare_at_value": null, "currency": "USD" },
            "sku": "CW2288-111",
            "option1": "White/White",
            "option2": "6",
            "url": "https://www.nike.com/t/air-force-1-07-mens-shoes-jBrhbr/CW2288-111#size-6",
            "image": {
              "url": "https://static.nike.com/a/images/t_default/.../AIR+FORCE+1+%2707.png",
              "alt_text": "Nike Air Force 1 '07 - White/White - 6 variant image",
              "position": 1,
              "width": 400,
              "height": 400,
              "id": "img-variant-variant-1769639694153-0",
              "variant_ids": ["variant-1769639694153-0"]
            }
          },
          { "_truncated": "Additional variants omitted for display" }
        ],
        "store_canonical_url": "https://www.nike.com/",
        "store_domain": "www.nike.com",
        "platform": null,
        "platform_id": "CW2288-111",
        "description_html": "<html>...</html>",
        "product_type": null,
        "google_product_category_id": null,
        "google_product_category_path": null,
        "tags": ["FOOTWEAR"],
        "video_url": null,
        "review_count": null,
        "average_rating": null,
        "rating_scale": null,
        "faqs": null,
        "reviews": null,
        "updated_at": "2026-01-28T22:34:54.186Z",
        "brand_pdp": null,
        "similar_products": null,
        "reddit_insights": null,
        "affiliate_link": "https://wild.link/e?...”
      },
      "success": true
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 50,
    "total_items": 1,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  }
}
When to use: After starting an extraction job with the POST endpoint, use this endpoint to:
  • Check if processing is complete
  • Monitor real-time progress
  • Retrieve paginated results when processing completes
  • Check if extraction is waiting for a crawl to complete

​
Request

​
x-api-key
string
required
Your API key for authentication
​
execution_id
string
required
The execution ID returned from POST /v2/extract

​
Query Parameters

​
page
number
default:"1"
Page number for paginated results (only applicable when status is “completed”)Minimum: 1
​
page_size
number
default:"50"
Number of results per page (only applicable when status is “completed”)Maximum: 100 Default: 50

​
Response

​
execution_id
string
The execution identifier
​
status
string
Current execution statusPossible values:
  • "pending" - Execution has been created but not yet started (may be waiting for crawl)
  • "running" - Execution is currently processing
  • "completed" - Execution finished successfully
  • "failed" - Execution failed or was aborted
​
error
string | null
Error message (always present, null if execution is successful or still running)Note: Error messages are sanitized for security. For vendor-based extractions waiting for a crawl, if the crawl fails, the error will be: “The crawl this extraction was waiting for failed or was canceled”
​
data
array
Array of product results (only present when status is “completed” and results are available)
​
pagination
object
Pagination information (only present when status is “completed” and results are available)
​
meta
object
Response metadata
cURL
# Check execution status (urls input)
curl -X GET "https://api.getcatalog.ai/v2/extract/extract-urls-965b1912-6af0-4ed8-b7e3-184b85e788b7" \
  -H "x-api-key: $CATALOG_API_KEY"


# Get results with pagination
curl -X GET "https://api.getcatalog.ai/v2/extract/extract-urls-965b1912-6af0-4ed8-b7e3-184b85e788b7?page=1&page_size=50" \
  -H "x-api-key: $CATALOG_API_KEY"

{
  "execution_id": "extract-urls-b45c2d8c-46b7-46c2-8fed-fa3788c75e2a",
  "status": "completed",
  "error": null,
  "meta": {
    "progress": {
      "products_processed": 1,
      "products_total": 1,
      "percent_complete": 100
    },
    "start_date": "2026-01-28T22:30:05.823Z",
    "stop_date": "2026-01-28T22:35:31.082Z",
    "duration_ms": 325259,
    "result": {
      "products_requested": 1,
      "products_successful": 1,
      "products_failed": 0
    },
    "credits_used": 5
  },
  "data": [
    {
      "url": "https://www.nike.com/t/air-force-1-07-mens-shoes-5QFp5Z/CW2288-111",
      "product": {
        "id": "6e6bd7bd-bfb5-4e05-85ee-4969628e741a",
        "title": "Nike Air Force 1 '07",
        "description": "Comfortable, durable and timeless—it’s number one for a reason. ...",
        "vendor": "nike.com",
        "brand": "Nike",
        "url": "https://www.nike.com/t/air-force-1-07-mens-shoes-5QFp5Z/CW2288-111",
        "handle": "cw2288-111",
        "is_available": true,
        "attributes": null,
        "price": { "current_value": 115, "compare_at_value": 115, "currency": "USD" },
        "images": [
          {
            "url": "https://static.nike.com/a/images/t_default/.../AIR+FORCE+1+%2707.png",
            "alt_text": "Nike Air Force 1 '07 product image (primary)",
            "position": 1,
            "width": 400,
            "height": 400,
            "id": "img-1769639694151-0",
            "variant_ids": ["variant-1769639694153-0", "_truncated"],
            "attributes": null
          },
          { "_truncated": "Additional image objects omitted for display" }
        ],
        "options": [
          { "name": "Color", "position": 1, "values": ["White/White"] },
          { "name": "Size", "position": 2, "values": ["6", "6.5", "7", "_truncated", "18"] }
        ],
        "variants": [
          {
            "id": "variant-1769639694153-0",
            "title": "Nike Air Force 1 '07 - White/white - 6",
            "is_available": true,
            "price": { "current_value": 115, "compare_at_value": null, "currency": "USD" },
            "sku": "CW2288-111",
            "option1": "White/White",
            "option2": "6",
            "url": "https://www.nike.com/t/air-force-1-07-mens-shoes-jBrhbr/CW2288-111#size-6",
            "image": {
              "url": "https://static.nike.com/a/images/t_default/.../AIR+FORCE+1+%2707.png",
              "alt_text": "Nike Air Force 1 '07 - White/White - 6 variant image",
              "position": 1,
              "width": 400,
              "height": 400,
              "id": "img-variant-variant-1769639694153-0",
              "variant_ids": ["variant-1769639694153-0"]
            }
          },
          { "_truncated": "Additional variants omitted for display" }
        ],
        "store_canonical_url": "https://www.nike.com/",
        "store_domain": "www.nike.com",
        "platform": null,
        "platform_id": "CW2288-111",
        "description_html": "<html>...</html>",
        "product_type": null,
        "google_product_category_id": null,
        "google_product_category_path": null,
        "tags": ["FOOTWEAR"],
        "video_url": null,
        "review_count": null,
        "average_rating": null,
        "rating_scale": null,
        "faqs": null,
        "reviews": null,
        "updated_at": "2026-01-28T22:34:54.186Z",
        "brand_pdp": null,
        "similar_products": null,
        "reddit_insights": null,
        "affiliate_link": "https://wild.link/e?...”
      },
      "success": true
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 50,
    "total_items": 1,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  }
}

​
Polling Strategy

For best results when waiting for completion:
  1. Initial Poll: Check status immediately after receiving execution_id
  2. Handle Pending with Waiting For: If status is "pending" with waiting_for in meta, the extraction is waiting for a crawl. Poll less frequently (every 30-60 seconds) until the crawl completes.
  3. Polling Interval: Wait 5-10 seconds between polls for running executions
  4. Exponential Backoff: Consider increasing wait time for long-running jobs
  5. Timeout: Set a maximum wait time based on your batch size and whether you’re waiting for a crawl