Aller au contenu
ExtentAPI

Search extractions — filtres combinés (where AST + sort).

POST
/v1/extractor/extractions/search
 
curl --request POST \
  --url https://api.extentapi.example/v1/extractor/extractions/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "where": "example", "sort": [ { "field": "createdAt", "dir": "asc" } ], "pagination": { "offset": 0, "limit": 50 } }'

Body {where?, sort?, pagination?}. Cf. docs/development/api-design.md §5.b. Retourne la même enveloppe {items, pagination, sort} que GET /.

Authorizations

Section intitulée « Authorizations »

Request Body required

Section intitulée « Request Body required »
Media type application/json
object
where
sort
Array<object>
object
field
required
string
Allowed values: createdAt id status type finishedAt
dir
required
string
Allowed values: asc desc
pagination
object
offset
integer
0
limit
integer
default: 50 >= 1 <= 200

Responses

Section intitulée « Responses »

200

Section intitulée « 200 »

Page d’extractions.

Media type application/json
object
status
required
string
Allowed value: success
code
required
string
data
required
object
items
required
Array<object>
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
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
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
pagination
required
object
offset
required
integer
limit
required
integer
> 0
total
required
integer
hasMore
required
boolean
sort
Array<object>
object
field
required
string
dir
required
string
Allowed values: asc desc
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": {
    "items": [
      {
        "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
      }
    ],
    "sort": [
      {
        "dir": "asc"
      }
    ]
  }
}

400

Section intitulée « 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

Section intitulée « 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

Section intitulée « 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

Section intitulée « 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

Section intitulée « 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"
}