Submit a Batch

curl --request POST \
  --url https://api.context.dev/v1/batch/submit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "type": "scrape",
    "data": {
      "type": "markdown",
      "urls": [
        {
          "url": "https://example.com/products/anvil",
          "itemId": "sku-1",
          "meta": {
            "category": "tools"
          }
        },
        {
          "url": "https://example.com/products/hammer",
          "itemId": "sku-2"
        }
      ],
      "options": {
        "useMainContentOnly": true
      }
    }
  }
}
'

{
  "id": "batch_9f2c8a",
  "status": "queued",
  "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/"
  },
  "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"
    }
  ],
  "webhook_secret": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

POST

batch

submit

curl --request POST \
  --url https://api.context.dev/v1/batch/submit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "type": "scrape",
    "data": {
      "type": "markdown",
      "urls": [
        {
          "url": "https://example.com/products/anvil",
          "itemId": "sku-1",
          "meta": {
            "category": "tools"
          }
        },
        {
          "url": "https://example.com/products/hammer",
          "itemId": "sku-2"
        }
      ],
      "options": {
        "useMainContentOnly": true
      }
    }
  }
}
'

{
  "id": "batch_9f2c8a",
  "status": "queued",
  "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/"
  },
  "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"
    }
  ],
  "webhook_secret": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

{
  "message": "<string>",
  "key_metadata": {
    "credits_consumed": 123,
    "credits_remaining": 123
  }
}

1 Credit per successful URL

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.

Headers

Idempotency-Key

string

Any string unique to this submission. Retries with the same key return the original batch.

Maximum string length: 200

Body

application/json

Create an asynchronous scraping job.

input

Scrape · object

required

Scrape up to 25K URLs in one batch.

Scrape
Crawl

Show child attributes

webhookUrl

string

URL notified when the batch finishes.

Response

Batch accepted. 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

Always queued. An accepted batch has not started yet.

Available options:

queued

mode

enum<string>

required

How pages will be selected.

Available options:

scrape,

crawl

format

enum<string>

required

What each page will be returned as.

Available options:

markdown,

html

Web Extraction

Batch Processing

Brand Intelligence

Entity Enrichment

Monitor Infrastructure

Utility

Authorizations

Headers

Body

Response