Retrieve an extraction

GET

/v1/extractor/extractions/{id}

const url = 'https://api.extentapi.example/v1/extractor/extractions/example';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.extentapi.example/v1/extractor/extractions/example \
  --header 'x-api-key: <x-api-key>'

Authorizations

apiKey

Parameters

Path Parameters

required

string

Responses

200

Extraction trouvée.

application/json

object

status

required

string

Allowed value: success

code

required

string

data

required

object

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

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>

metadata

required

object

inputFormat

required

string

Allowed values: html markdown text json

strategiesUsed

Array<string>

default:

configsApplied

Array<string>

default:

durationMs

integer

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

cacheHits

integer

recycleCount

integer

createdAt

required

string format: date-time

finishedAt

required

string | null format: date-time

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

401

Authentification manquante ou invalide.

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

404

Ressource introuvable (ou hors-tenant).

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