Documents

Les Documents contiennent les données extraites de vos fichiers téléchargés. Utilisez ces endpoints pour récupérer les identifiants de documents, accéder aux données extraites, télécharger les fichiers originaux et gérer les documents.

Récupérer les Documents

GET https://api.koncile.ai/v1/fetch_documents

Récupère une liste de tous les identifiants de documents de votre entreprise.

Paramètres de requête

start_date Date Optionnel Filtre les documents créés à partir de cette date (format : AAAA-MM-JJ)

end_date Date Optionnel Filtre les documents créés jusqu'à cette date (format : AAAA-MM-JJ)

Retourne

Un tableau d'identifiants de documents.

curl "https://api.koncile.ai/v1/fetch_documents" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

# Avec filtres de date
curl "https://api.koncile.ai/v1/fetch_documents?start_date=2024-01-01&end_date=2024-12-31" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

import requests

response = requests.get(
    "https://api.koncile.ai/v1/fetch_documents",
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

# Avec filtres de date
response = requests.get(
    "https://api.koncile.ai/v1/fetch_documents",
    params={"start_date": "2024-01-01", "end_date": "2024-12-31"},
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

const response = await fetch("https://api.koncile.ai/v1/fetch_documents", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.API_KEY}`
  }
});
const data = await response.json();

// Avec filtres de date
const filtered = await fetch(
  "https://api.koncile.ai/v1/fetch_documents?start_date=2024-01-01&end_date=2024-12-31",
  {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${process.env.API_KEY}`
    }
  }
);
const filteredData = await filtered.json();

Récupérer les données d'un Document

GET https://api.koncile.ai/v1/fetch_document_data

Récupère les données extraites d'un document spécifique.

Paramètres de requête

document_id Integer Obligatoire L'identifiant du document à récupérer

Retourne

document_id Integer L'identifiant du document

template_id Integer Le template utilisé pour l'extraction

document_name String Nom du fichier original

General_fields Object Champs extraits une fois par document, avec valeurs et scores de confiance

General_fields_list Array Mêmes champs généraux en format liste

Line_fields Object Champs extraits pour chaque ligne, avec tableaux de valeurs et scores de confiance

task_id String Identifiant de tâche associé (si applicable)

curl "https://api.koncile.ai/v1/fetch_document_data?document_id=123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

import requests

response = requests.get(
    "https://api.koncile.ai/v1/fetch_document_data",
    params={"document_id": 123},
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

const response = await fetch(
  "https://api.koncile.ai/v1/fetch_document_data?document_id=123",
  {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${process.env.API_KEY}`
    }
  }
);
const data = await response.json();

Récupérer un Fichier

GET https://api.koncile.ai/v1/fetch_file

Télécharge le fichier original associé à un document.

Paramètres de requête

document_id Integer Conditionnel L'identifiant du document. Requis si task_id n'est pas fourni

task_id String Conditionnel L'identifiant de la tâche. Requis si document_id n'est pas fourni

Fournissez soit document_id SOIT task_id, mais pas les deux.

Retourne

Le fichier sous forme de flux binaire.

# Avec document_id
curl "https://api.koncile.ai/v1/fetch_file?document_id=123" \
  -H "Authorization: Bearer $API_KEY" \
  -o fichier_telecharge.pdf

# Avec task_id
curl "https://api.koncile.ai/v1/fetch_file?task_id=EOBdOSUX4Uv57YWsLYc4JQ" \
  -H "Authorization: Bearer $API_KEY" \
  -o fichier_telecharge.pdf

import requests

# Avec document_id
response = requests.get(
    "https://api.koncile.ai/v1/fetch_file",
    params={"document_id": 123},
    headers={"Authorization": f"Bearer {API_KEY}"}
)

# Avec task_id
response = requests.get(
    "https://api.koncile.ai/v1/fetch_file",
    params={"task_id": "EOBdOSUX4Uv57YWsLYc4JQ"},
    headers={"Authorization": f"Bearer {API_KEY}"}
)

# Sauvegarder le fichier
with open("fichier_telecharge.pdf", "wb") as f:
    f.write(response.content)

const fs = require("fs");

// Avec document_id
const response = await fetch(
  "https://api.koncile.ai/v1/fetch_file?document_id=123",
  {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${process.env.API_KEY}`
    }
  }
);

// Avec task_id
const responseByTask = await fetch(
  "https://api.koncile.ai/v1/fetch_file?task_id=EOBdOSUX4Uv57YWsLYc4JQ",
  {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${process.env.API_KEY}`
    }
  }
);

// Sauvegarder le fichier
const buffer = await response.arrayBuffer();
fs.writeFileSync("fichier_telecharge.pdf", Buffer.from(buffer));

Récupérer des Fichiers en lot

POST https://api.koncile.ai/v1/fetch_files_batch

Télécharge plusieurs fichiers simultanément et les retourne sous forme d'archive ZIP.

Corps de la requête

document_ids Array[Integer] Conditionnel Liste des identifiants de documents à télécharger

task_ids Array[String] Conditionnel Liste des identifiants de tâches à résoudre en documents

Au moins un des paramètres document_ids ou task_ids doit être fourni. Vous pouvez fournir les deux pour combiner les résultats.

Retourne

Un fichier ZIP contenant tous les fichiers demandés.

curl -X POST "https://api.koncile.ai/v1/fetch_files_batch" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"document_ids": [123, 124, 125]}' \
  -o documents.zip

import requests

response = requests.post(
    "https://api.koncile.ai/v1/fetch_files_batch",
    json={"document_ids": [123, 124, 125]},
    headers={"Authorization": f"Bearer {API_KEY}"}
)

# Sauvegarder le fichier
with open("documents.zip", "wb") as f:
    f.write(response.content)

const fs = require("fs");

const response = await fetch("https://api.koncile.ai/v1/fetch_files_batch", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": `Bearer ${process.env.API_KEY}`
  },
  body: JSON.stringify({ document_ids: [123, 124, 125] })
});

// Sauvegarder le fichier
const buffer = await response.arrayBuffer();
fs.writeFileSync("documents.zip", Buffer.from(buffer));

Supprimer un Document

DELETE https://api.koncile.ai/v1/delete_doc

Supprime un document du système.

Paramètres de requête

doc_id Integer Obligatoire L'identifiant du document à supprimer

delete_file Boolean Optionnel Si true, supprime également le fichier sous-jacent. Par défaut : false

Retourne

Réponse vide en cas de succès.

# Supprimer le document uniquement
curl -X DELETE "https://api.koncile.ai/v1/delete_doc?doc_id=123" \
  -H "Authorization: Bearer $API_KEY"

# Supprimer le document et le fichier
curl -X DELETE "https://api.koncile.ai/v1/delete_doc?doc_id=123&delete_file=true" \
  -H "Authorization: Bearer $API_KEY"

import requests

# Supprimer le document uniquement
response = requests.delete(
    "https://api.koncile.ai/v1/delete_doc",
    params={"doc_id": 123},
    headers={"Authorization": f"Bearer {API_KEY}"}
)

# Supprimer le document et le fichier
response = requests.delete(
    "https://api.koncile.ai/v1/delete_doc",
    params={"doc_id": 123, "delete_file": True},
    headers={"Authorization": f"Bearer {API_KEY}"}
)

// Supprimer le document uniquement
await fetch("https://api.koncile.ai/v1/delete_doc?doc_id=123", {
  method: "DELETE",
  headers: {
    "Authorization": `Bearer ${process.env.API_KEY}`
  }
});

// Supprimer le document et le fichier
await fetch("https://api.koncile.ai/v1/delete_doc?doc_id=123&delete_file=true", {
  method: "DELETE",
  headers: {
    "Authorization": `Bearer ${process.env.API_KEY}`
  }
});

PreviousInstructions NextCodes de statut API

Last updated 19 days ago

Was this helpful?

hashtagRécupérer les Documents

hashtagParamètres de requête

hashtagRetourne

hashtagRécupérer les données d'un Document

hashtagParamètres de requête

hashtagRetourne

hashtagRécupérer un Fichier

hashtagParamètres de requête

hashtagRetourne

hashtagRécupérer des Fichiers en lot

hashtagCorps de la requête

hashtagRetourne

hashtagSupprimer un Document

hashtagParamètres de requête

hashtagRetourne

Récupérer les Documents

Paramètres de requête

Retourne

Récupérer les données d'un Document

Paramètres de requête

Retourne

Récupérer un Fichier

Paramètres de requête

Retourne

Récupérer des Fichiers en lot

Corps de la requête

Retourne

Supprimer un Document

Paramètres de requête

Retourne