Create a job

POST

/v1/scraper/jobs

curl --request POST \
  --url http://localhost:8080/v1/scraper/jobs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "url": "https://example.com", "priority": 1, "webhookUrl": "https://example.com", "timeoutMs": 1, "escalation": [ { "engine": "http", "attempts": 1, "timeoutMs": 1 } ], "screenshot": { "format": "png", "quality": 1, "fullPage": true, "loadResources": "images" } }'

• Dev (Bun.serve, défaut local).
• Remplacer par l'URL prod.

Enqueue un crawl pour l’URL fournie. Codes: 201-created. Idempotent via header Idempotency-Key (TTL 24 h).

Authorizations

• apiKey

Request Body ^required

Media type application/json

object

url

required

string format: uri

priority

integer

<= 10

webhookUrl

string | null format: uri

timeoutMs

integer

>= 15000 <= 300000

escalation

Array<object>

>= 1 items <= 8 items

object

engine

required

string

Allowed values: http camoufox brave alternate

attempts

required

integer

>= 1 <= 5

timeoutMs

required

integer

>= 1000 <= 180000

screenshot

Any of:

boolean

boolean

object

object

format

string

Allowed values: png jpeg

quality

integer

>= 1 <= 100

fullPage

boolean

loadResources

string

Allowed values: images images_fonts all

Responses

201

Job créé et enqueué.

Media type application/json

object

status

required

string

Allowed value: success

code

required

string

data

required

object

id

required

string

url

required

string

status

required

string

Allowed values: queued claimed done failed dead

priority

required

integer

attempts

required

integer

createdAt

required

string format: date-time

finishedAt

required

string | null format: date-time

domainId

required

string

tenantId

required

string

cache

object

hit

required

boolean

key

string

ageSeconds

integer

expiresAt

string format: date-time

timing

object

totalMs

required

integer

dbMs

integer

externalMs

integer

deprecation

object

sunset

required

string format: date-time

successor

string

note

string

Example

{
  "status": "success",
  "data": {
    "status": "queued"
  }
}

400

Requête mal formée (validation_error, invalid_idempotency_key, invalid_sort_field, invalid_filter).

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

401

Authentification manquante ou invalide.

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

403

Scope insuffisant (forbidden, no_active_plan, service_disabled_on_plan).

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

422

Validation métier KO (unsafe_url, invalid_bulk_body).

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

429

Rate-limit dépassé. Header Retry-After retourné.

Media type application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}