GET /crawl/{id}

GET

crawl

{id}

GET /crawl/{id}

curl --request GET \
  --url https://apix.pline.ai/v1/crawl/{id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://apix.pline.ai/v1/crawl/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.pline.ai/v1/crawl/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "5f0d6c1e-3a52-4b6e-9c40-1c7f2b8a9d11",
  "status": "crawling",
  "limit": 200,
  "total": 200,
  "completed": 143,
  "failed": 2,
  "pending": 55,
  "inFlight": 4,
  "createdAt": "2026-10-10T09:30:00Z",
  "duration": 91.4
}

{
  "id": "5f0d6c1e-3a52-4b6e-9c40-1c7f2b8a9d11",
  "status": "completed",
  "limit": 200,
  "total": 200,
  "completed": 198,
  "failed": 2,
  "pending": 0,
  "inFlight": 0,
  "createdAt": "2026-10-10T09:30:00Z",
  "completedAt": "2026-10-10T09:33:12Z",
  "duration": 192.0,
  "s3PresignedUrls": {
    "markdown": "https://downloads.example.com/crawl-markdown.zip"
  }
}

{
  "detail": "Crawl job not found."
}

{
  "detail": "Crawling is temporarily unavailable. Retry shortly."
}

Poll the status of a crawl job started with POST /crawl. Once completed, s3PresignedUrls provides download links for the result artifacts — see Delivery for the full set of ways to receive crawl results.

Authorization

Send your pline API key in the X-API-Key header on every request.

Path parameters

string

required

Crawl job ID returned by POST /crawl.

Response

string

required

Crawl job ID.

string

required

Current status: crawling, completed, failed, or cancelled.

integer

required

Maximum pages this job may process, as requested.

integer

required

Total pages attempted so far.

integer

required

Pages scraped successfully so far.

integer

required

Pages that failed so far.

integer

required

Pages waiting to be scraped.

integer

required

Pages being scraped right now.

string

required

ISO 8601 timestamp the crawl started.

string

ISO 8601 timestamp the job finished. Present once it has.

number

required

Elapsed seconds since the crawl started.

object

Download links, one per requested output format, available once status is completed. Links expire. Each link is a ZIP archive with one file per crawled page and a manifest.json that maps each file to its source URL.

string

Failure message when status is failed.

Response codes

Code	Meaning
`200`	Crawl status and download links
`404`	Crawl job not found.
`503`	Crawling is temporarily unavailable. Retry shortly.

{
  "id": "5f0d6c1e-3a52-4b6e-9c40-1c7f2b8a9d11",
  "status": "crawling",
  "limit": 200,
  "total": 200,
  "completed": 143,
  "failed": 2,
  "pending": 55,
  "inFlight": 4,
  "createdAt": "2026-10-10T09:30:00Z",
  "duration": 91.4
}

{
  "id": "5f0d6c1e-3a52-4b6e-9c40-1c7f2b8a9d11",
  "status": "completed",
  "limit": 200,
  "total": 200,
  "completed": 198,
  "failed": 2,
  "pending": 0,
  "inFlight": 0,
  "createdAt": "2026-10-10T09:30:00Z",
  "completedAt": "2026-10-10T09:33:12Z",
  "duration": 192.0,
  "s3PresignedUrls": {
    "markdown": "https://downloads.example.com/crawl-markdown.zip"
  }
}

{
  "detail": "Crawl job not found."
}

{
  "detail": "Crawling is temporarily unavailable. Retry shortly."
}

GET /crawl/{id}

curl --request GET \
  --url https://apix.pline.ai/v1/crawl/{id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://apix.pline.ai/v1/crawl/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.pline.ai/v1/crawl/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "5f0d6c1e-3a52-4b6e-9c40-1c7f2b8a9d11",
  "status": "crawling",
  "limit": 200,
  "total": 200,
  "completed": 143,
  "failed": 2,
  "pending": 55,
  "inFlight": 4,
  "createdAt": "2026-10-10T09:30:00Z",
  "duration": 91.4
}

{
  "id": "5f0d6c1e-3a52-4b6e-9c40-1c7f2b8a9d11",
  "status": "completed",
  "limit": 200,
  "total": 200,
  "completed": 198,
  "failed": 2,
  "pending": 0,
  "inFlight": 0,
  "createdAt": "2026-10-10T09:30:00Z",
  "completedAt": "2026-10-10T09:33:12Z",
  "duration": 192.0,
  "s3PresignedUrls": {
    "markdown": "https://downloads.example.com/crawl-markdown.zip"
  }
}

{
  "detail": "Crawl job not found."
}

{
  "detail": "Crawling is temporarily unavailable. Retry shortly."
}

Scrape

Batch scrape

Map

Crawl

SERP

GET /crawl/{id}

Authorization

Path parameters

Response

Response codes

​Authorization

​Path parameters

​Response

​Response codes

Authorization

Path parameters

Response

Response codes