Submit a batch

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    input: {
      mode: 'scrape',
      data: {
        urls: [
          {
            url: 'https://example.com/products/anvil',
            itemId: 'sku-1',
            meta: {category: 'tools'}
          },
          {url: 'https://example.com/products/hammer', itemId: 'sku-2'}
        ],
        formats: {markdown: true, html: true},
        sharedParams: {mainContentOnly: true}
      }
    }
  })
};

fetch('https://api.context.dev/v1/batch/submit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "batch_9f2c8a",
  "status": "pending",
  "mode": "scrape",
  "tags": [
    "docs"
  ],
  "crawl": {
    "source": {
      "type": "start_url",
      "url": "https://example.com/docs"
    },
    "max_pages": 500,
    "max_depth": 0,
    "follow_subdomains": true,
    "url_pattern": "^https://example\\.com/docs/",
    "exclude_url_pattern": "/tag/|/author/",
    "languages": "same_as_start_url"
  },
  "input": {
    "reserved": 24817,
    "reserved_is_ceiling": false,
    "submitted": 25000,
    "duplicates": 183,
    "invalid": 0
  },
  "credits": {
    "reserved": 24817
  },
  "created_at": "<string>",
  "invalid_urls": [
    {
      "url": "<string>",
      "reason": "Must be a public http:// or https:// URL"
    }
  ],
  "cache_metadata": {
    "status": "hit",
    "age_ms": 1
  },
  "formats": {
    "html": true,
    "markdown": true
  },
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "webhook_secret": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

POST

batch

submit

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    input: {
      mode: 'scrape',
      data: {
        urls: [
          {
            url: 'https://example.com/products/anvil',
            itemId: 'sku-1',
            meta: {category: 'tools'}
          },
          {url: 'https://example.com/products/hammer', itemId: 'sku-2'}
        ],
        formats: {markdown: true, html: true},
        sharedParams: {mainContentOnly: true}
      }
    }
  })
};

fetch('https://api.context.dev/v1/batch/submit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "batch_9f2c8a",
  "status": "pending",
  "mode": "scrape",
  "tags": [
    "docs"
  ],
  "crawl": {
    "source": {
      "type": "start_url",
      "url": "https://example.com/docs"
    },
    "max_pages": 500,
    "max_depth": 0,
    "follow_subdomains": true,
    "url_pattern": "^https://example\\.com/docs/",
    "exclude_url_pattern": "/tag/|/author/",
    "languages": "same_as_start_url"
  },
  "input": {
    "reserved": 24817,
    "reserved_is_ceiling": false,
    "submitted": 25000,
    "duplicates": 183,
    "invalid": 0
  },
  "credits": {
    "reserved": 24817
  },
  "created_at": "<string>",
  "invalid_urls": [
    {
      "url": "<string>",
      "reason": "Must be a public http:// or https:// URL"
    }
  ],
  "cache_metadata": {
    "status": "hit",
    "age_ms": 1
  },
  "formats": {
    "html": true,
    "markdown": true
  },
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "webhook_secret": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "message": "<string>",
  "error_code": "PROFILE_NOT_FOUND",
  "error_data": {
    "is_authenticated": true,
    "should_retry": false,
    "retry_condition": "sufficient_credits",
    "info_url": "https://context.dev/dashboard/subscription",
    "credits_remaining": 1,
    "credits_required": 1,
    "is_credits_required_estimated": true,
    "credits_charged": 1,
    "next_refill_at": "2023-11-07T05:31:56Z",
    "next_refill_credits": 123
  },
  "required_permission": "logs:read",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

From 1 credit per page Requires batches:write permission. See the guide for examples and usage.

Authorizations

Authorization

string

header

required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Headers

Idempotency-Key

string

Unique key per submission. Retrying with the same key and body returns the original batch; a different body returns 409.

Maximum string length: 200

Body

application/json

Create an asynchronous scraping job.

input

Scrape · object

required

Scrape a list of up to 100,000 URLs.

Scrape
Crawl

Show child attributes

webhookUrl

string<uri>

Legacy URL notified when the batch finishes. Preserves one best-effort attempt. Cannot be combined with webhook.

webhook

object

Where to send the batch's final-status event. Omit retry for one attempt; {} uses the default retry schedule.

Show child attributes

Response

Batch stored. Reserved page counts and credits remain zero until background preparation finishes. Read progress and results from GET /batch/{batch_id}.

string

required

Batch ID. Poll GET /batch/{batch_id} with it.

Example:

"batch_9f2c8a"

status

enum<string>

required

Current state. pending means waiting for execution capacity or background validation. Capacity-limited batches remain pending until a slot opens. completed, cancelled, and failed are final.

Available options:

pending,

queued,

running,

cancelling,

completed,

cancelled,

failed

mode

enum<string>

required

How pages will be selected.

Available options:

scrape,

crawl

Web Data

Brand Data

Entity Enrichment

Batches

Monitors

Webhook Deliveries

Access Policies

Account

Agent Feedback

Authorizations

Headers

Body

Response