Lancer une extraction de données

POST

/v1/extractor/extractions

curl --request POST \
  --url https://api.extentapi.example/v1/extractor/extractions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "type": "article", "format": "html", "content": { "additionalProperty": "example" }, "url": "https://example.com", "domain": "example", "webhookUrl": "https://example.com", "webhookSecret": "example", "webhookEventTypes": [ "done" ], "forceRefresh": true, "options": { "useLlm": true, "llmModel": "example", "llmPromptOverride": "example", "llmMode": "fill-missing" } }'

• Production.

Extrayez des données structurées depuis une URL ou un contenu fourni. Réponse immédiate (200) si le résultat est déjà en cache (cache.hit=true), sinon traitement asynchrone (202) — récupérez le résultat par polling ou webhook.

Authorizations

• apiKey

Request Body ^required

Media type application/json

object

type

required

string

Allowed values: article product

format

string

default: html

Allowed values: html markdown text json

content

required

Any of:

string

string

object

object

key

additional properties

url

string format: uri

domain

string

webhookUrl

string format: uri

webhookSecret

string

>= 16 characters <= 200 characters

webhookEventTypes

Array<string>

Allowed values: done failed dead

forceRefresh

boolean

options

object

useLlm

boolean

llmModel

string

llmPromptOverride

string

<= 8000 characters

llmMode

string

Allowed values: fill-missing correct

Responses

200

Cache hit.

Media type application/json

object

status

required

string

Allowed value: success

code

required

string

data

required

object

id

required

string

type

required

string

Allowed values: article product

status

required

string

Allowed values: queued claimed done failed dead cancelled

url

required

string | null

domainId

required

string | null

tenantId

required

string

inputFormat

required

string

Allowed values: html markdown text json

data

required

Any of:

object

object

title

required

string

>= 1 characters

content

required

string

description

string

summary

string

author

string

authors

Array<string>

publishedAt

string format: date-time

modifiedAt

string format: date-time

lang

string

images

Array<object>

object

url

required

string

alt

string

width

integer

>= 1

height

integer

>= 1

tags

Array<string>

object

object

name

required

string

>= 1 characters

description

string

price

number

currency

string

availability

string

sku

string

brand

string

images

Array<object>

object

url

required

string

alt

string

width

integer

>= 1

height

integer

>= 1

attributes

object

key

additional properties

null

null

metadata

required

object

inputFormat

required

string

Allowed values: html markdown text json

strategiesUsed

Array<string>

default:

configsApplied

Array<string>

default:

durationMs

integer

0

truncated

boolean

detectedLanguage

string

rootSelector

string

llm

object

model

required

string

status

required

string

Allowed values: ok failed_validation failed_request failed_timeout

refinedFields

Array<string>

default:

correctedFields

Array<string>

default:

rejectedRefines

Array<string>

default:

promptTokens

integer

completionTokens

integer

durationMs

required

integer

errorMessage

string | null

errorClass

string | null

Allowed values: parse_error sanitize_fail llm_request llm_validation llm_timeout llm_unavailable invalid_input input_stash_lost cancelled_by_admin unknown

attempts

integer

0

cacheHits

integer

0

recycleCount

integer

0

createdAt

required

string format: date-time

finishedAt

required

string | null format: date-time

webhookSecret

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": {
    "type": "article",
    "status": "queued",
    "inputFormat": "html",
    "metadata": {
      "inputFormat": "html",
      "strategiesUsed": [],
      "configsApplied": [],
      "durationMs": 0,
      "llm": {
        "status": "ok",
        "refinedFields": [],
        "correctedFields": [],
        "rejectedRefines": []
      }
    },
    "errorClass": "parse_error",
    "attempts": 0,
    "cacheHits": 0,
    "recycleCount": 0
  }
}

202

Cache miss enqueued.

Media type application/json

object

status

required

string

Allowed value: success

code

required

string

data

required

object

id

required

string

type

required

string

Allowed values: article product

status

required

string

Allowed values: queued claimed done failed dead cancelled

url

required

string | null

domainId

required

string | null

tenantId

required

string

inputFormat

required

string

Allowed values: html markdown text json

data

required

Any of:

object

object

title

required

string

>= 1 characters

content

required

string

description

string

summary

string

author

string

authors

Array<string>

publishedAt

string format: date-time

modifiedAt

string format: date-time

lang

string

images

Array<object>

object

url

required

string

alt

string

width

integer

>= 1

height

integer

>= 1

tags

Array<string>

object

object

name

required

string

>= 1 characters

description

string

price

number

currency

string

availability

string

sku

string

brand

string

images

Array<object>

object

url

required

string

alt

string

width

integer

>= 1

height

integer

>= 1

attributes

object

key

additional properties

null

null

metadata

required

object

inputFormat

required

string

Allowed values: html markdown text json

strategiesUsed

Array<string>

default:

configsApplied

Array<string>

default:

durationMs

integer

0

truncated

boolean

detectedLanguage

string

rootSelector

string

llm

object

model

required

string

status

required

string

Allowed values: ok failed_validation failed_request failed_timeout

refinedFields

Array<string>

default:

correctedFields

Array<string>

default:

rejectedRefines

Array<string>

default:

promptTokens

integer

completionTokens

integer

durationMs

required

integer

errorMessage

string | null

errorClass

string | null

Allowed values: parse_error sanitize_fail llm_request llm_validation llm_timeout llm_unavailable invalid_input input_stash_lost cancelled_by_admin unknown

attempts

integer

0

cacheHits

integer

0

recycleCount

integer

0

createdAt

required

string format: date-time

finishedAt

required

string | null format: date-time

webhookSecret

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": {
    "type": "article",
    "status": "queued",
    "inputFormat": "html",
    "metadata": {
      "inputFormat": "html",
      "strategiesUsed": [],
      "configsApplied": [],
      "durationMs": 0,
      "llm": {
        "status": "ok",
        "refinedFields": [],
        "correctedFields": [],
        "rejectedRefines": []
      }
    },
    "errorClass": "parse_error",
    "attempts": 0,
    "cacheHits": 0,
    "recycleCount": 0
  }
}

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"
}

413

Payload trop volumineux.

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"
}