Documents

Notes
Niveau expert
La clé API doit être envoyée comme un jeton porteur dans l'en-tête d'autorisation de la requête. Obtenez votre clé API.
Liste

Point de terminaison API:

GET 
https://assistant.eclixia.com/api/v1/documents

Exemple de requête: 

curl --location --request GET 'https://assistant.eclixia.com/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
facultatif string
La requête de recherche.
search_by
facultatif string
Rechercher par. Les valeurs possibles sont name pour Nom, result pour Résultat. Valeur par défaut : name.
template_id
facultatif integer
Filtrer par ID de modèle. Les valeurs possibles sont 1 pour Freestyle, 2 pour À propos de nous, 3 pour Publicité, 4 pour Article, 5 pour Introduction du blog, 6 pour Plan d'article de blog, 7 pour Conclusion du blog, 8 pour Paragraphe de blog, 9 pour Article de blog, 10 pour Section du blog, 11 pour Points de discussion du blog, 12 pour Titre du blog, 13 pour Appel à l'action, 14 pour Réécriture de contenu, 15 pour Résumé du contenu, 16 pour FAQ, 17 pour Hashtags, 18 pour Titre, 19 pour Comment ça marche, 20 pour Méta-description, 21 pour Mots-clés méta, 22 pour Déclaration de mission, 23 pour Bulletin d'information, 24 pour Douleur-Agitation-Solution, 25 pour Paragraphe, 26 pour Communiqué de presse, 27 pour Publication sur les réseaux sociaux, 28 pour Légende de la publication sur les réseaux sociaux, 29 pour Idées de start-up, 30 pour Noms de start-up, 31 pour Sous-titre, 32 pour Témoignage, 33 pour Social media quote, 34 pour Biographie sur les réseaux sociaux, 35 pour Proposition de valeur, 36 pour Description de la vidéo, 37 pour Script vidéo, 38 pour Étiquettes vidéo, 39 pour Titre de la vidéo, 40 pour Déclaration de vision, 41 pour Fiche produit, 42 pour E-mail de bienvenue, 43 pour Notification push, 44 pour Listicle de blog, 45 pour Grammaire du contenu, 46 pour Balises de blog, 47 pour Avantages et inconvénients, 48 pour Publicité Google, 49 pour Publicité Facebook, 50 pour Description de poste, 51 pour Critique, 52 pour Section des fonctionnalités. Valeur par défaut : freestyle.
favorite
facultatif boolean
Filtrer par favori.
sort_by
facultatif string
Trier par. Les valeurs possibles sont id pour Date de création, name pour Nom. Valeur par défaut : id.
sort
facultatif string
Trier. Les valeurs possibles sont desc pour Décroissant, asc pour Croissant. Valeur par défaut : desc.
per_page
facultatif integer
Résultats par page. Les valeurs possibles sont 10, 25, 50, 100. Valeur par défaut : 10.
Afficher

Point de terminaison API:

GET 
https://assistant.eclixia.com/api/v1/documents/{id}

Exemple de requête: 

curl --location --request GET 'https://assistant.eclixia.com/api/v1/documents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Magasin

Point de terminaison API:

POST 
https://assistant.eclixia.com/api/v1/documents

Exemple de requête: 

curl --location --request POST 'https://assistant.eclixia.com/api/v1/documents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'prompt={prompt}'
Paramètre
Type
Description
name
requis string
Le nom du document.
prompt
requis string
Les instructions pour l'IA.
creativity
requis float
The creative level of the result. Les valeurs possibles sont 0 pour Répétitif, 0.25 pour Déterministe, 0.5 pour Original, 0.75 pour Créatif, 1 pour Imaginatif. Valeur par défaut : 0.5.
Mettre à jour

Point de terminaison API:

PUT PATCH 
https://assistant.eclixia.com/api/v1/documents/{id}

Exemple de requête: 

curl --location --request PUT 'https://assistant.eclixia.com/api/v1/documents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
name
facultatif string
Le nom du document.
result
facultatif string
Le résultat du document.
favorite
facultatif boolean
Que le document soit favori ou non.
Supprimer

Point de terminaison API:

DELETE 
https://assistant.eclixia.com/api/v1/documents/{id}

Exemple de requête: 

curl --location --request DELETE 'https://assistant.eclixia.com/api/v1/documents/{id}' \
--header 'Authorization: Bearer {api_key}'