Request

Method and path	POST`/v1/crawls/{id}/cancel`
Base URL	`https://api.boxline.dev`
Authentication	Your API key in the `x-api-key` header (or `Authorization: Bearer`). The examples read it from `BOXLINE_API_KEY`.

Path parameters

Name	Type	Default	Allowed values	Description
`id`required	`string`	–	–

curl -X POST "https://api.boxline.dev/v1/crawls/$CRAWL_ID/cancel" \  -H "x-api-key: $BOXLINE_API_KEY"

import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst job = await bx.crawl.cancel("CRAWL_ID");console.log(job.status); // "canceled"

from boxline import Boxlinebx = Boxline()  # reads BOXLINE_API_KEY and BOXLINE_API_URLjob = bx.crawl.cancel("CRAWL_ID")print(job["status"])  # canceled

Responses

200 OK

The job.

Fields

Name	Type	Default	Allowed values	Description
`id`	`string`	–	–
`status`	`string`	–	`running`, `completed`, `failed`, `canceled`
`url`	`string`	–	–
`params`	`object`	–	–	The crawl's settings (proxy without passwords).
`pagesDone`	`integer`	–	–
`pagesFailed`	`integer`	–	–
`skippedByRobots`	`integer`	–	–
`error`	`string \| null`	–	–
`createdAt`	`string`	–	–	Format: date-time.
`finishedAt`	`string \| null`	–	–	Format: date-time.
`data`	`object[]`	–	–
`data[].index`	`integer`	–	–
`data[].url`	`string`	–	–
`data[].finalUrl`	`string \| null`	–	–
`data[].status`	`integer \| null`	–	–
`data[].title`	`string \| null`	–	–
`data[].depth`	`integer`	–	–
`data[].content`	`string \| null`	–	–
`data[].captcha`	`string \| null`	–	`recaptcha`, `hcaptcha`, `turnstile`, `cloudflare`, `datadome`, `arkose`, `human`
`data[].error`	`string \| null`	–	–
`next`	`string \| null`	–	–	Pass it back as `after` for the next page; null on the last page.

Response 200

{  "id": "crawl_2Gh7Kx0Lq9Zp4Nm3",  "status": "running",  "url": "https://example.com/",  "params": {},  "pagesDone": 0,  "pagesFailed": 0,  "skippedByRobots": 0,  "error": "…",  "createdAt": "2026-09-29T10:00:00.000Z",  "finishedAt": "2026-09-29T10:00:00.000Z",  "data": [    {      "index": 0,      "url": "https://example.com/",      "finalUrl": "https://example.com/",      "status": 0,      "title": "Example Domain",      "depth": 0,      "content": "…",      "captcha": "recaptcha",      "error": "…"    }  ],  "next": "eyJvIjoiY3JlYXRlZF9kZXNjIiwidCI6IjIwMjYtMDktMjlUMTA6MDA6MDAuMTIzNDU2WiIsImkiOiI2YzFmIn0"}

Errors

Errors have a matching HTTP status and the same body. code is stable, so check it in your code; message is for people. See Errors and request ids.

Status	Codes	When
401 Unauthorized	`unauthorized`	Missing or invalid API key.
404 Not Found	`not_found`, `invite_not_found`, `provider_unavailable`	No such thing in this project (or organization), or no such route.

Error body

{  "error": {    "code": "not_found",    "message": "session not found",    "requestId": "req_4fJx0aQm2Lk9Pz7N"  }}

Learn more

CrawlThe guide to this part of the API, with more examples.

These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.