Templates

Les Templates sont des modèles de configuration créés dans les Folders pour définir comment les documents doivent être traités et quelles données doivent être extraites.

Créer un Template

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

Crée un nouveau Template.

Paramètres de requête

folder_id Integer Obligatoire L'identifiant du Folder contenant le Template

Corps de la requête

name String Obligatoire Le nom unique du Template

desc String Optionnel Une description du Template

number_locale String Optionnel Format des nombres : EU ou US

date_locale String Optionnel Format des dates : EU ou US

Retourne

L'objet Template créé.

curl -X POST "https://api.koncile.ai/v1/create_template/?folder_id=1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"name": "Facture Standard", "desc": "Template pour les factures", "number_locale": "EU", "date_locale": "EU"}'

import requests

response = requests.post(
    "https://api.koncile.ai/v1/create_template/",
    params={"folder_id": 1},
    json={
        "name": "Facture Standard",
        "desc": "Template pour les factures",
        "number_locale": "EU",
        "date_locale": "EU"
    },
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

const response = await fetch("https://api.koncile.ai/v1/create_template/?folder_id=1", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": `Bearer ${process.env.API_KEY}`
  },
  body: JSON.stringify({
    name: "Facture Standard",
    desc: "Template pour les factures",
    number_locale: "EU",
    date_locale: "EU"
  })
});
const data = await response.json();

Récupérer un Template

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

Récupère toutes les informations d'un Template en utilisant le template_id.

Paramètres de requête

template_id Integer Obligatoire L'identifiant du Template à récupérer

Retourne

L'objet Template.

curl "https://api.koncile.ai/v1/fetch_template?template_id=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

import requests

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

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

Mettre à jour un Template

PUT https://api.koncile.ai/v1/update_template

Met à jour un Template en utilisant le template_id.

Paramètres de requête

template_id Integer Obligatoire L'identifiant du Template à modifier

Corps de la requête

name String Optionnel Le nouveau nom du Template

desc String Optionnel La nouvelle description

number_locale String Optionnel Le nouveau format des nombres : EU ou US

date_locale String Optionnel Le nouveau format des dates : EU ou US

Retourne

L'objet Template modifié.

curl -X PUT "https://api.koncile.ai/v1/update_template?template_id=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"name": "Nouveau nom", "desc": "Nouvelle description"}'

import requests

response = requests.put(
    "https://api.koncile.ai/v1/update_template",
    params={"template_id": 10},
    json={"name": "Nouveau nom", "desc": "Nouvelle description"},
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

const response = await fetch("https://api.koncile.ai/v1/update_template?template_id=10", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
    "Authorization": `Bearer ${process.env.API_KEY}`
  },
  body: JSON.stringify({name: "Nouveau nom", desc: "Nouvelle description"})
});
const data = await response.json();

Supprimer un Template

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

Supprime un Template en utilisant le template_id.

Paramètres de requête

template_id Integer Obligatoire L'identifiant du Template à supprimer

override Boolean Optionnel Si True, force la suppression des documents contenus. Par défaut False

Retourne

Réponse vide en cas de succès.

curl -X DELETE "https://api.koncile.ai/v1/delete_template?template_id=10" \
  -H "Authorization: Bearer $API_KEY"

Structure de l'objet Template

id Integer Identifiant unique du Template

name String Le nom du Template

desc String La description du Template

folder_id Integer L'identifiant du Folder parent

field_ids Array Liste des identifiants des Fields dans le Template

instruction_ids Array Liste des identifiants des Instructions dans le Template

Exemple :

{
  "id": 10,
  "name": "Facture Standard",
  "desc": "Template pour les factures fournisseurs",
  "folder_id": 1,
  "field_ids": [100, 101, 102],
  "instruction_ids": [200, 201]
}

PreviousFolders NextFields

Last updated 19 days ago

Was this helpful?

hashtagCréer un Template

hashtagParamètres de requête

hashtagCorps de la requête

hashtagRetourne

hashtagRécupérer un Template

hashtagParamètres de requête

hashtagRetourne

hashtagMettre à jour un Template

hashtagParamètres de requête

hashtagCorps de la requête

hashtagRetourne

hashtagSupprimer un Template

hashtagParamètres de requête

hashtagRetourne

hashtagStructure de l'objet Template

Créer un Template

Paramètres de requête

Corps de la requête

Retourne

Récupérer un Template

Paramètres de requête

Retourne

Mettre à jour un Template

Paramètres de requête

Corps de la requête

Retourne

Supprimer un Template

Paramètres de requête

Retourne

Structure de l'objet Template