Créer un job AI extraction

curl --request POST \
  --url https://partner-api.marko.fr/v1/workflows/ai-extraction-jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "document_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "operation_id": null
}
'

import requests

url = "https://partner-api.marko.fr/v1/workflows/ai-extraction-jobs"

payload = {
    "document_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "operation_id": None
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const url = 'https://partner-api.marko.fr/v1/workflows/ai-extraction-jobs';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({document_id: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa', operation_id: null})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({document_id: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa', operation_id: null})
};

fetch('https://partner-api.marko.fr/v1/workflows/ai-extraction-jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.marko.fr/v1/workflows/ai-extraction-jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'document_id' => 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa',
    'operation_id' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "11111111-1111-4111-8111-111111111111",
  "workflow_id": null,
  "workflow_name": null,
  "workflow_source": "system",
  "job_type": "ai_extraction",
  "preset_key": null,
  "status": "pending",
  "entity_type": null,
  "entity_id": null,
  "retry_count": 0,
  "error_message": null,
  "result": {},
  "document_id": null,
  "operation_id": null,
  "filename": null,
  "document_type": null,
  "suggestions_count": null,
  "pending_suggestions": null,
  "applied_suggestions": null,
  "summary": null,
  "created_at": null,
  "started_at": null,
  "completed_at": null
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Idempotency-Key must contain at most 255 visible ASCII characters without spaces.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "detail": "The idempotency key payload, external reference, target, or source conflicts with an existing write.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Precondition Required",
  "status": 428,
  "detail": "The Idempotency-Key header is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Authorizations

Authorization

string

header

required

Use the access_token returned by POST /v1/auth/token. Do not send the raw API secret on business endpoints.

Headers

X-Request-ID

string

Partner-generated correlation identifier echoed in logs and error payloads.

Idempotency-Key

string

required

Required for every write, including environments where replay deduplication is disabled. Reuse the same value when retrying the same logical write and use a new value for a different write.

Maximum string length: 255

Pattern: ^[!-~]+$

Body

application/json

document_id

string<uuid>

required

UUID MARKO du document.

operation_id

string<uuid> | null

UUID MARKO de l'opération.

Response

Successful response

string<uuid>

required

Identifiant MARKO de la ressource.

workflow_id

null

required

Clé du workflow; certaines routes utilisent une chaîne, d'autres un UUID. Respectez le type de cette route.

workflow_name

null

required

Nom du workflow à l'origine de l'exécution.

workflow_source

string

required

Origine du workflow à l'origine de l'exécution.

Allowed value: "system"

job_type

enum<string>

required

Type de traitement exécuté par le job.

Available options:

ai_extraction,

ai_categorization,

kpi_calculation,

echeancier_generation

preset_key

null

required

Clé du preset de workflow; utiliser une valeur du catalogue de presets.

status

enum<string>

required

État du traitement; lire job_type pour identifier sa fonction et error_message pour diagnostiquer un échec.

Available options:

pending,

running,

completed,

failed,

dead_letter,

cancelled

entity_type

string | null

required

Type de ressource auquel se rapporte la vue ou le traitement.

entity_id

string<uuid> | null

required

Identifiant de la ressource ciblée par le job, dont le type est donné par entity_type; ce n'est pas nécessairement l'entité administrative.

retry_count

integer

required

Nombre de reprises enregistrées pour ce traitement.

error_message

string | null

required

Détail de l'échec, lorsqu'il est disponible.

result

object

required

Objet JSON métier; les clés dépendent de la source ou du preset.

document_id

string | null

required

UUID MARKO du document.

operation_id

string | null

required

UUID MARKO de l'opération.

filename

string | null

required

Nom du fichier.

document_type

string | null

required

Type métier du document; distinct de son type MIME.

suggestions_count

integer | null

required

Nombre total de suggestions associées à ce job.

pending_suggestions

integer | null

required

Nombre de suggestions de ce job qui attendent encore un traitement.

applied_suggestions

integer | null

required

Nombre de suggestions appliquées pour ce job.

summary

any

required

Valeur JSON variable selon la source ou le preset; aucun schéma fixe n'est imposé par cette route.

created_at

string<date-time> | null

required

Date de création au format ISO 8601.

started_at

string<date-time> | null

required

Date de début du traitement.

completed_at

string<date-time> | null

required

Date de fin, lorsqu'une exécution ou un traitement est terminé.

Créer un job AI extraction

curl --request POST \
  --url https://partner-api.marko.fr/v1/workflows/ai-extraction-jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "document_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "operation_id": null
}
'

import requests

url = "https://partner-api.marko.fr/v1/workflows/ai-extraction-jobs"

payload = {
    "document_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "operation_id": None
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const url = 'https://partner-api.marko.fr/v1/workflows/ai-extraction-jobs';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({document_id: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa', operation_id: null})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({document_id: 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa', operation_id: null})
};

fetch('https://partner-api.marko.fr/v1/workflows/ai-extraction-jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.marko.fr/v1/workflows/ai-extraction-jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'document_id' => 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa',
    'operation_id' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "11111111-1111-4111-8111-111111111111",
  "workflow_id": null,
  "workflow_name": null,
  "workflow_source": "system",
  "job_type": "ai_extraction",
  "preset_key": null,
  "status": "pending",
  "entity_type": null,
  "entity_id": null,
  "retry_count": 0,
  "error_message": null,
  "result": {},
  "document_id": null,
  "operation_id": null,
  "filename": null,
  "document_type": null,
  "suggestions_count": null,
  "pending_suggestions": null,
  "applied_suggestions": null,
  "summary": null,
  "created_at": null,
  "started_at": null,
  "completed_at": null
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Idempotency-Key must contain at most 255 visible ASCII characters without spaces.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "detail": "The idempotency key payload, external reference, target, or source conflicts with an existing write.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Precondition Required",
  "status": 428,
  "detail": "The Idempotency-Key header is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Démarrer

Tutoriels

Intégrer

Référence API

Créer un job AI extraction

Authorizations

Headers

Body

Response