Get Execution Status

Get extract status and results for an asynchronous extract job.

GET /v1/products/{execution_id}

cURL

PowerShell

# Check execution status
curl -X GET "https://api.getcatalog.ai/v1/products/products-batch-550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: $CATALOG_API_KEY"

# Get results with pagination
curl -X GET "https://api.getcatalog.ai/v1/products/products-batch-550e8400-e29b-41d4-a716-446655440000?page=1&limit=50" \
  -H "x-api-key: $CATALOG_API_KEY"

Status: Completed

{
  "status": "completed",
  "progress": {
    "products_processed": 1,
    "urls_completed": 1,
    "total_urls": 1,
    "percent_complete": 100
  },
  "error": null,
  "credits_used": 5,
  "results": {
    "products": [
      {
        "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. ... Style: CW2288-111",
          "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": {
            "additional_attributes": [
              "classic '80s construction",
              "bold design details",
              "smooth leather upper",
              "... more ..."
            ],
            "age_group": "adult",
            "gender": "unisex",
            "summary": "Timeless Nike Air Force 1 '07 sneakers combining classic '80s construction with smooth leather and durable, comfortable design.",
            "features": "Durable construction, cushioned midsole for support, and iconic silhouette suitable for various occasions.",
            "care_instructions": "Wipe clean with a damp cloth, avoid heavy cleaning solutions, air dry away from direct heat.",
            "color": { "iscc_family": "white", "merchant_label": "White/White" },
            "material": { "primary": "leather", "merchant_label": "Smooth Leather" },
            "pattern": "solid",
            "closure_type": "lace-up",
            "season": ["year-round"],
            "style": ["casual", "classic", "streetwear"],
            "mood": ["confident", "timeless"],
            "occasion": ["everyday", "casual", "sports-event"],
            "additional_product_information": "Benefits: ...\nProduct details: ...\nFit note: Fits large; we recommend ordering a half size down."
          },
          "price": { "currency": "USD", "current_value": 115, "compare_at_value": 115 },
          "images": [
            {
              "id": "img-1769639694151-0",
              "url": "https://static.nike.com/a/images/t_default/.../AIR+FORCE+1+%2707.png",
              "width": 400,
              "height": 400,
              "alt_text": "Nike Air Force 1 '07 product image (primary)",
              "position": 1,
              "variant_ids": ["variant-1769639694153-0", "..."],
              "attributes": null
            },
            "..."
          ],
          "options": [
            { "name": "Color", "values": ["White/White"], "position": 1 },
            { "name": "Size", "values": ["6", "6.5", "7", "...", "18"], "position": 2 }
          ],
          "variants": [
            {
              "id": "variant-1769639694153-0",
              "sku": "CW2288-111",
              "url": "https://www.nike.com/t/air-force-1-07-mens-shoes-jBrhbr/CW2288-111#size-6",
              "image": {
                "id": "img-variant-variant-1769639694153-0",
                "url": "https://static.nike.com/a/images/t_default/.../AIR+FORCE+1+%2707.png",
                "width": 400,
                "height": 400,
                "alt_text": "Nike Air Force 1 '07 - White/White - 6 variant image",
                "position": 1,
                "variant_ids": ["variant-1769639694153-0"]
              },
              "price": { "currency": "USD", "current_value": 115, "compare_at_value": null },
              "title": "Nike Air Force 1 '07 - White/white - 6",
              "option1": "White/White",
              "option2": "6",
              "is_available": true,
              "affiliate_link": "https://wild.link/e?...#size-6"
            },
            "..."
          ],
          "store_canonical_url": "https://www.nike.com/",
          "store_domain": "www.nike.com",
          "platform": null,
          "platform_id": "CW2288-111",
          "description_html": "<html>...</html>",
          "product_type": "FOOTWEAR",
          "google_product_category_id": "187",
          "google_product_category_path": "Apparel & Accessories > Shoes",
          "tags": ["FOOTWEAR"],
          "video_url": null,
          "review_count": null,
          "average_rating": null,
          "rating_scale": null,
          "faqs": null,
          "reviews": null,
          "updated_at": "2026-01-28T22:53:52.255Z",
          "similar_products": null,
          "affiliate_link": "https://wild.link/e?...CW2288-111"
        },
        "success": true,
        "outcome": "success",
        "retry": false,
        "message": ""
      }
    ],
    "meta": {
      "total_requested": 1,
      "total_successful": 1,
      "total_failed": 0,
      "total_failed_by_reason": {},
      "total_invalid": 0,
      "total_invalid_by_reason": {},
      "total_pending": 0
    }
  },
  "pagination": {
    "page": 1,
    "limit": 50,
    "total_items": 1,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  }
}

When to use: After starting a batch processing job with the POST endpoint, use this endpoint to:

• Check if processing is complete
• Monitor real-time progress
• Retrieve paginated results when processing completes

Managing Executions:

• View All Executions: Use GET /v1/products to see all your processing jobs
• Cancel Running Executions: If you need to stop a running execution, use DELETE /v1/products/{execution_id}

Authentication Required: This endpoint requires a valid API key. The API key is verified, but execution IDs are not restricted to specific API keys. Keep your execution IDs secure.

Request

x-api-key · string · required

Your API key for authentication

execution_id · string · required

The execution ID returned from POST /v1/products

Format: products-batch-{uuid}

Note: If the execution ID does not exist, the endpoint returns a 404 Not Found error.

Query Parameters

page · number · default: "1"

Page number for paginated results (only applicable when status is “completed”)

Minimum: 1

limit · number · default: "50"

Number of results per page (only applicable when status is “completed”)

Maximum: 100

Response

status · string

Current execution status

Possible values:

• "pending" - Execution has been created but not yet started
• "running" - Execution is currently processing
• "completed" - Execution finished successfully
• "failed" - Execution failed or was aborted

progress · object | null

Real-time progress information (null if not available)

Show Progress Properties

products_processed · number

Number of products successfully processed so far

urls_completed · number

Number of URLs that have been completed (successfully or with errors)

total_urls · number

Total number of URLs in the batch

percent_complete · number

Percentage of completion (0-100)

error · string | null

Error message (always present, null if execution is successful or still running)

results · object

Product results (only present when status is “completed”)

Hide Results Properties

products · array

Array of product results, one for each input URL

Hide Product Result

url · string

Original URL that was processed

success · boolean

Whether the product was successfully processed

product · object | null

Product data (null if processing failed)

Hide Product Properties

id · string

Unique product identifier

title · string

Product title

description · string

Detailed product description

vendor · string

Store/retailer name (e.g., “net-a-porter”, “Nike”)

brand · string | null

Product brand name (e.g., “LOEFFLER RANDALL”, “Nike”)

url · string

Product URL

handle · string

Product handle/slug

is_available · boolean

Product availability status

price_amount · number | null

Price in dollars

price_currency · string | null

Currency code (e.g., “USD”)

min_price · number | null

Minimum price for variants

max_price · number | null

Maximum price for variants

images · array

Array of product images

options · array

Array of product options (size, color, etc.)

variants · array

Array of product variants with detailed information

store_canonical_url · string | null

Canonical store URL

store_domain · string

Store domain

platform · string | null

E-commerce platform (null if not identified)

platform_id · string | null

Platform-specific ID

description_html · string | null

HTML-formatted description

product_type · string | null

Product type/category

google_product_category_id · string | null

Google product category identifier

google_product_category_path · string | null

Full Google product category path

tags · array

Array of product tags/categories

video_url · string | null

Product video URL (if available)

updated_at · string

Last update timestamp (ISO 8601)

attributes · object

Comprehensive product attributes (when AI enrichment is enabled)

outcome · string

The outcome category for this URL.

Possible values:

• "success" — Product data was extracted successfully
• "non_product_url" — The URL does not point to a product page (e.g. category page, 404, homepage redirect)
• "malformed_url" — The URL format is invalid or unparseable
• "automated_access_not_permitted" — The site’s bot protection blocked automated access
• "other" — A temporary error occurred during processing

retry · boolean

Whether retrying this URL may produce a successful result. When true, the failure is likely transient — resubmit the URL in a new request. When false, the URL itself needs fixing — check message for specifics.

message · string

A human-readable description of the outcome with recommended next steps. Empty string on success.

final_url · string

The URL the browser landed on after following redirects. Only present when the final URL differs from the input url. Useful for diagnosing non_product_url outcomes caused by redirects.

meta · object

Processing metadata and summary statistics. The following invariant always holds: total_successful + total_failed + total_invalid + total_pending = total_requested.

Show Meta Properties

total_requested · number

Total number of URLs submitted in the extraction request

total_successful · number

Number of URLs where product data was extracted successfully

total_failed · number

Number of URLs where extraction failed due to retriable issues. Equal to the sum of values in total_failed_by_reason.

total_failed_by_reason · object

Breakdown of retriable failures by outcome. Keys are only present when their count is greater than zero. Resubmitting these URLs in a new extraction request may succeed.

Show Failed Breakdown

automated_access_not_permitted · number

URLs where the site’s bot protection blocked automated access. This is often transient — retrying typically succeeds. If it persists for a specific site, contact support.

other · number

URLs that encountered a temporary processing error (e.g. timeout, unexpected page state). Safe to retry immediately.

total_invalid · number

Number of URLs with input problems that cannot be resolved by retrying. Equal to the sum of values in total_invalid_by_reason.

total_invalid_by_reason · object

Breakdown of invalid URLs by outcome. Keys are only present when their count is greater than zero. These URLs need to be corrected before resubmitting — retrying the same URL will produce the same result.

Show Invalid Breakdown

non_product_url · number

URLs that did not resolve to a product page. Common causes include category pages, 404s, and homepage redirects. Check the per-URL final_url field to see where the browser ended up.

malformed_url · number

URLs with invalid format (e.g. missing protocol, unencoded characters). Fix the URL and resubmit.

total_pending · number

URLs still being processed. Always present; 0 when extraction is complete.

pagination · object

Pagination information (only present when status is “completed” and results are available)

Show Pagination Properties

page · number

Current page number

limit · number

Number of results per page

total_items · number

Total number of results across all pages

total_pages · number

Total number of pages

has_next · boolean

Whether there is a next page

cURL

PowerShell

# Check execution status
curl -X GET "https://api.getcatalog.ai/v1/products/products-batch-550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: $CATALOG_API_KEY"

# Get results with pagination
curl -X GET "https://api.getcatalog.ai/v1/products/products-batch-550e8400-e29b-41d4-a716-446655440000?page=1&limit=50" \
  -H "x-api-key: $CATALOG_API_KEY"

Status: Completed

{
  "status": "completed",
  "progress": {
    "products_processed": 1,
    "urls_completed": 1,
    "total_urls": 1,
    "percent_complete": 100
  },
  "error": null,
  "credits_used": 5,
  "results": {
    "products": [
      {
        "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. ... Style: CW2288-111",
          "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": {
            "additional_attributes": [
              "classic '80s construction",
              "bold design details",
              "smooth leather upper",
              "... more ..."
            ],
            "age_group": "adult",
            "gender": "unisex",
            "summary": "Timeless Nike Air Force 1 '07 sneakers combining classic '80s construction with smooth leather and durable, comfortable design.",
            "features": "Durable construction, cushioned midsole for support, and iconic silhouette suitable for various occasions.",
            "care_instructions": "Wipe clean with a damp cloth, avoid heavy cleaning solutions, air dry away from direct heat.",
            "color": { "iscc_family": "white", "merchant_label": "White/White" },
            "material": { "primary": "leather", "merchant_label": "Smooth Leather" },
            "pattern": "solid",
            "closure_type": "lace-up",
            "season": ["year-round"],
            "style": ["casual", "classic", "streetwear"],
            "mood": ["confident", "timeless"],
            "occasion": ["everyday", "casual", "sports-event"],
            "additional_product_information": "Benefits: ...\nProduct details: ...\nFit note: Fits large; we recommend ordering a half size down."
          },
          "price": { "currency": "USD", "current_value": 115, "compare_at_value": 115 },
          "images": [
            {
              "id": "img-1769639694151-0",
              "url": "https://static.nike.com/a/images/t_default/.../AIR+FORCE+1+%2707.png",
              "width": 400,
              "height": 400,
              "alt_text": "Nike Air Force 1 '07 product image (primary)",
              "position": 1,
              "variant_ids": ["variant-1769639694153-0", "..."],
              "attributes": null
            },
            "..."
          ],
          "options": [
            { "name": "Color", "values": ["White/White"], "position": 1 },
            { "name": "Size", "values": ["6", "6.5", "7", "...", "18"], "position": 2 }
          ],
          "variants": [
            {
              "id": "variant-1769639694153-0",
              "sku": "CW2288-111",
              "url": "https://www.nike.com/t/air-force-1-07-mens-shoes-jBrhbr/CW2288-111#size-6",
              "image": {
                "id": "img-variant-variant-1769639694153-0",
                "url": "https://static.nike.com/a/images/t_default/.../AIR+FORCE+1+%2707.png",
                "width": 400,
                "height": 400,
                "alt_text": "Nike Air Force 1 '07 - White/White - 6 variant image",
                "position": 1,
                "variant_ids": ["variant-1769639694153-0"]
              },
              "price": { "currency": "USD", "current_value": 115, "compare_at_value": null },
              "title": "Nike Air Force 1 '07 - White/white - 6",
              "option1": "White/White",
              "option2": "6",
              "is_available": true,
              "affiliate_link": "https://wild.link/e?...#size-6"
            },
            "..."
          ],
          "store_canonical_url": "https://www.nike.com/",
          "store_domain": "www.nike.com",
          "platform": null,
          "platform_id": "CW2288-111",
          "description_html": "<html>...</html>",
          "product_type": "FOOTWEAR",
          "google_product_category_id": "187",
          "google_product_category_path": "Apparel & Accessories > Shoes",
          "tags": ["FOOTWEAR"],
          "video_url": null,
          "review_count": null,
          "average_rating": null,
          "rating_scale": null,
          "faqs": null,
          "reviews": null,
          "updated_at": "2026-01-28T22:53:52.255Z",
          "similar_products": null,
          "affiliate_link": "https://wild.link/e?...CW2288-111"
        },
        "success": true,
        "outcome": "success",
        "retry": false,
        "message": ""
      }
    ],
    "meta": {
      "total_requested": 1,
      "total_successful": 1,
      "total_failed": 0,
      "total_failed_by_reason": {},
      "total_invalid": 0,
      "total_invalid_by_reason": {},
      "total_pending": 0
    }
  },
  "pagination": {
    "page": 1,
    "limit": 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. Polling Interval: Wait 5-10 seconds between polls for running executions
3. Exponential Backoff: Consider increasing wait time for long-running jobs
4. Timeout: Set a maximum wait time based on your batch size