Folders

Les Folders servent de conteneurs qui organisent différents types de documents et Templates dans Koncile.

Créer un Folder

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

Crée un nouveau Folder.

Corps de la requête

name String Obligatoire Le nom du Folder à créer

desc String Optionnel Une description détaillée de l'objectif ou du contenu du Folder

Retourne

L'objet Folder créé.

curl -X POST "https://api.koncile.ai/v1/create_folder/" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"name": "Factures fournisseurs", "desc": "Toutes les factures des fournisseurs"}'

import requests

response = requests.post(
    "https://api.koncile.ai/v1/create_folder/",
    json={"name": "Factures fournisseurs", "desc": "Toutes les factures des fournisseurs"},
    headers={"Authorization": f"Bearer {API_KEY}"}
)
print(response.json())

const response = await fetch("https://api.koncile.ai/v1/create_folder/", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": `Bearer ${process.env.API_KEY}`
  },
  body: JSON.stringify({
    name: "Factures fournisseurs",
    desc: "Toutes les factures des fournisseurs"
  })
});
const data = await response.json();

Récupérer tous les Folders

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

Récupère tous les Folders de votre entreprise ainsi que leurs Templates associés.

Retourne

L'objet folders contenant un tableau d'objets Folder.

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

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

Exemple de réponse :

{
  "folders": [
    {
      "id": 1,
      "name": "Factures",
      "desc": "Tous les documents de facturation",
      "templates": [
        {"id": 10, "name": "Facture Standard", "desc": "Modèle de facture générique"},
        {"id": 11, "name": "Facture Internationale", "desc": "Factures multi-devises"}
      ]
    }
  ]
}

Récupérer un Folder

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

Récupère toutes les informations d'un Folder en utilisant le folder_id.

Paramètres de requête

folder_id Integer Obligatoire L'identifiant du Folder à récupérer

Retourne

L'objet Folder.

curl "https://api.koncile.ai/v1/fetch_folder?folder_id=1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY"

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

Mettre à jour un Folder

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

Met à jour un Folder en utilisant le folder_id.

Paramètres de requête

folder_id Integer Obligatoire L'identifiant du Folder à modifier

Corps de la requête

name String Optionnel Le nouveau nom du Folder

desc String Optionnel La nouvelle description

Retourne

L'objet Folder modifié.

curl -X PUT "https://api.koncile.ai/v1/update_folder?folder_id=1" \
  -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_folder",
    params={"folder_id": 1},
    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_folder?folder_id=1", {
  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 Folder

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

Supprime un Folder en utilisant le folder_id.

Paramètres de requête

folder_id Integer Obligatoire L'identifiant du Folder à supprimer

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

Retourne

Réponse vide en cas de succès.

curl -X DELETE "https://api.koncile.ai/v1/delete_folder?folder_id=1" \
  -H "Authorization: Bearer $API_KEY"

Structure de l'objet Folder

id Integer Identifiant unique du Folder

name String Le nom du Folder

desc String La description du Folder

templates Array Liste des Templates dans le Folder, chacun contenant id, name et desc

Exemple :

{
  "id": 1,
  "name": "Mon Folder",
  "desc": "Description",
  "templates": [
    {"id": 10, "name": "Template 1", "desc": "..."},
    {"id": 11, "name": "Template 2", "desc": "..."}
  ]
}

PreviousRécupération des tâches par Polling NextTemplates

Last updated 19 days ago

Was this helpful?

hashtagCréer un Folder

hashtagCorps de la requête

hashtagRetourne

hashtagRécupérer tous les Folders

hashtagRetourne

hashtagRécupérer un Folder

hashtagParamètres de requête

hashtagRetourne

hashtagMettre à jour un Folder

hashtagParamètres de requête

hashtagCorps de la requête

hashtagRetourne

hashtagSupprimer un Folder

hashtagParamètres de requête

hashtagRetourne

hashtagStructure de l'objet Folder

Créer un Folder

Corps de la requête

Retourne

Récupérer tous les Folders

Retourne

Récupérer un Folder

Paramètres de requête

Retourne

Mettre à jour un Folder

Paramètres de requête

Corps de la requête

Retourne

Supprimer un Folder

Paramètres de requête

Retourne

Structure de l'objet Folder