Skip to main content
POST
Create Scraping Job
Creates a new document scraping job that runs asynchronously in the background.

Request Body

Required Fields

Parameters Object

Example Request

Response (201 Created)

Response Fields

Error Responses

Authorizations

Authorization
string
header
required

API key in format 'sk-xxxxxxxxxxxxx' or 'sk_xxxxxxxxxxxxx'

Body

application/json
website
string<uri>
required

Starting URL to scrape (must be valid HTTP/HTTPS URL)

Example:

"https://example.com"

prompt
string
required

Description of documents to find (10-500 characters)

Required string length: 10 - 500
Example:

"Find board meeting minutes from 2025"

parameters
object

Response

Job created successfully

job_id
string

Unique identifier for the created job

Pattern: ^job_[a-z0-9]+$
Example:

"job_4fc79a89797e"

status
enum<string>

Initial job status (always 'pending')

Available options:
pending
message
string

Success message

Example:

"Job created successfully and queued for processing"

estimated_completion
string<date-time>

ISO 8601 estimated completion time

created_at
string<date-time>

ISO 8601 job creation timestamp