GET /batch/scrape/{id}

GET

batch

scrape

{id}

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

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

fetch('https://apix.pline.ai/v1/batch/scrape/{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/batch/scrape/{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": "8a1c9e2e-4b7b-4a3a-9d0a-9b2a6e6f9c22",
  "status": "scraping",
  "limit": 100,
  "total": 100,
  "completed": 40,
  "failed": 1,
  "pending": 59,
  "inFlight": 4,
  "createdAt": "2026-10-10T09:30:00Z",
  "duration": 35.2
}

{
  "id": "8a1c9e2e-4b7b-4a3a-9d0a-9b2a6e6f9c22",
  "status": "completed",
  "limit": 100,
  "total": 100,
  "completed": 99,
  "failed": 1,
  "pending": 0,
  "inFlight": 0,
  "createdAt": "2026-10-10T09:30:00Z",
  "completedAt": "2026-10-10T09:31:20Z",
  "duration": 80.0,
  "s3PresignedUrls": {
    "markdown": "https://downloads.example.com/batch-markdown.jsonl"
  }
}

{
  "detail": "Batch scrape job not found."
}

{
  "detail": "Batch scraping is temporarily unavailable. Retry shortly."
}

Poll the status of a batch scrape job started with POST /batch/scrape. Once completed, s3PresignedUrls provides download links for the result artifacts.

Authorization

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

Path parameters

string

required

Batch scrape job ID returned by POST /batch/scrape.

Response

string

required

Batch scrape job job ID.

string

required

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

integer

required

Maximum URLs this job may process, as requested.

integer

required

Total URLs attempted so far.

integer

required

Urls scraped successfully so far.

integer

required

Urls that failed so far.

integer

required

Urls waiting to be scraped.

integer

required

Urls being scraped right now.

string

required

ISO 8601 timestamp the job started.

string

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

number

required

Elapsed seconds since the job started.

object

Download links, one per requested output format, available once status is completed. Links expire. Each link is a JSONL file with one line per URL: url, success, status, finalUrl, output, and error.

string

Failure message when status is failed.

Response codes

Code	Meaning
`200`	Batch scrape status metadata
`404`	Batch scrape job not found.
`503`	Batch scraping is temporarily unavailable. Retry shortly.

{
  "id": "8a1c9e2e-4b7b-4a3a-9d0a-9b2a6e6f9c22",
  "status": "scraping",
  "limit": 100,
  "total": 100,
  "completed": 40,
  "failed": 1,
  "pending": 59,
  "inFlight": 4,
  "createdAt": "2026-10-10T09:30:00Z",
  "duration": 35.2
}

{
  "id": "8a1c9e2e-4b7b-4a3a-9d0a-9b2a6e6f9c22",
  "status": "completed",
  "limit": 100,
  "total": 100,
  "completed": 99,
  "failed": 1,
  "pending": 0,
  "inFlight": 0,
  "createdAt": "2026-10-10T09:30:00Z",
  "completedAt": "2026-10-10T09:31:20Z",
  "duration": 80.0,
  "s3PresignedUrls": {
    "markdown": "https://downloads.example.com/batch-markdown.jsonl"
  }
}

{
  "detail": "Batch scrape job not found."
}

{
  "detail": "Batch scraping is temporarily unavailable. Retry shortly."
}

GET /batch/scrape/{id}

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

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

fetch('https://apix.pline.ai/v1/batch/scrape/{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/batch/scrape/{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": "8a1c9e2e-4b7b-4a3a-9d0a-9b2a6e6f9c22",
  "status": "scraping",
  "limit": 100,
  "total": 100,
  "completed": 40,
  "failed": 1,
  "pending": 59,
  "inFlight": 4,
  "createdAt": "2026-10-10T09:30:00Z",
  "duration": 35.2
}

{
  "id": "8a1c9e2e-4b7b-4a3a-9d0a-9b2a6e6f9c22",
  "status": "completed",
  "limit": 100,
  "total": 100,
  "completed": 99,
  "failed": 1,
  "pending": 0,
  "inFlight": 0,
  "createdAt": "2026-10-10T09:30:00Z",
  "completedAt": "2026-10-10T09:31:20Z",
  "duration": 80.0,
  "s3PresignedUrls": {
    "markdown": "https://downloads.example.com/batch-markdown.jsonl"
  }
}

{
  "detail": "Batch scrape job not found."
}

{
  "detail": "Batch scraping is temporarily unavailable. Retry shortly."
}

Scrape

Batch scrape

Map

Crawl

SERP

GET /batch/scrape/{id}

Authorization

Path parameters

Response

Response codes

​Authorization

​Path parameters

​Response

​Response codes

Authorization

Path parameters

Response

Response codes