> For the complete documentation index, see [llms.txt](https://cleyrop.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cleyrop.gitbook.io/docs/projet-data-and-ia/studio-ai/utiliser-un-assistant-dans-un-systeme-metier.md).

# Utiliser un Assistant dans un système métier

{% hint style="warning" %}
La création de nouveaux Assistants IA est bloquée : ils seront prochainement décommissionnés au profit des **Agents**. Utilisez les Tools **Cleyrop Corpus** et **Cleyrop Dataset** dans vos Agents pour retrouver les mêmes usages (interrogation de corpus de documents et de datasets).
{% endhint %}

La fonctionnalité **Exposer un Assistant IA** permet de rendre un assistant accessible via une **API REST sécurisée**, afin qu’il puisse être utilisé directement depuis un autre système :

* un outil métier interne
* un dashboard applicatif,
* ou un workflow automatisé.

Chaque appel à l’API est authentifié à l’aide d’un **token d’accès** projet, garantissant la sécurité et la traçabilité des requêtes.

Une documentation complète des endpoints de l’API est disponible à : `https://api.cleyrop./api/docs`

***

## Créer un token d’accès

Pour exposer un assistant, vous devez générer un token depuis le projet concerné.

**Étapes de création**

1. Accédez à l’onglet Tokens depuis la page d’accueil du projet. Ou cliquez directement sur Partager via API depuis la fiche d’un assistant.
2. Cliquez sur Créer un token.
3. Saisissez un nom et une date de fin de validité.
4. Sélectionnez les assistants à exposer : vous visualisez également les datasets ou corpus auxquels ils ont accès.
5. Validez la création du token.

Vous pouvez **modifier** ou **révoquer un token** créé

#### Visualiser les tokens existants

Tous les tokens sont listés dans l’onglet Tokens du projet.

Pour chaque token, vous pouvez consulter :

* le nom et le créateur,
* la date de création, d’expiration, de dernière utilisation et de modification,
* la liste des ressources partagées (assistants et périmètres de connaissances associés).

Depuis la fiche d’un assistant, l’onglet Tokens affiche également la liste des tokens lui donnant accès.

## Utiliser l’API

L’API est accessible via l’URL suivante : `https://cleyrop./api/v1/assistants/<assistant_id>`

| domaine       | Le domaine de votre plateforme (ex. maplateforme.net).          |
| ------------- | --------------------------------------------------------------- |
| assistant\_id | L’ID de votre assistant (visible dans sa fiche d’informations). |

Le token doit être transmis dans le header HTTP sous la clé apiKey.

{% hint style="warning" %}
Attention : l’exposition d’un assistant via API est réservée aux IP whitelistés.
{% endhint %}

**Exemple de requête CURL**

{% code title="assistant api call" %}

```bash
curl -X 'GET' \
  'https://api.cleyrop.maplateforme.net/api/v1/assistants/76a3cbdb-b391-4742-b95a-382b7e5d08f2' \
  -H 'accept: application/json' \
  -H 'apiKey: T79oLnbhjE8VPaGI2CElieEkeAA4ueuDznwM_w14qEE'
```

{% endcode %}
