Applications IA

Une application est une application d'IA réutilisable : un modèle, des champs d'entrée que votre appelant remplit, et les instructions envoyées au modèle. Vous créez les applications avec cette ressource, puis vous les exécutez avec Exécutions IA. Une application reste privée à votre projet tant que vous ne la publiez pas.

Points d'accès

<app_id> est un identifiant d'application, préfixé mapp_. La modification se fait sur le chemin detail ; il n'y a pas de chemin de mise à jour distinct. L'API ne supprime pas d'application.

L'objet app

Chaque entrée de data décrit un champ d'entrée :

tokens couvre toute la vie de l'application, et non le cycle de facturation en cours, et ne compte que les exécutions de votre propre projet. Les exécutions terminées sur une erreur sont exclues. Voir Quota et consommation de jetons IA pour les chiffres du cycle en cours.

Créer une application

POST /v1/ai/app/create demande un nom, une description, au moins un champ d'entrée et au moins une instruction.

Envoyez category, model ou model_library pour que l'API puisse choisir un modèle ; model_library l'emporte sur model, qui l'emporte sur category.

curl -X POST https://api.ultineo.com/v1/ai/app/create \
  -H "Authorization: Bearer sk-project-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Support triage",
    "description": "Sorts an inbound support message by urgency.",
    "category": "classify",
    "data": [
      { "type": "text area", "name": "message", "placeholder": "Paste the message", "required": true }
    ],
    "instruction": [
      { "type": "text", "instruction": "Classify the message as low, normal or urgent." }
    ]
  }'

{
  "code": 200,
  "title": "OK",
  "response": {
    "id": "mapp_0ceacb46e5b3a99e91b6",
    "object": "app",
    "name": "Support triage",
    "description": "Sorts an inbound support message by urgency.",
    "category": "classify",
    "catalog_category": "",
    "model": "modi_c2b7e9a1d3f0a8645c8e",
    "model_library": "mlyi_c2a1e7d9b4f30685c3a3",
    "data": {
      "madi_5d8b21c74e0af96b3d15": {
        "type": "text area",
        "value": "message",
        "placeholder": "Paste the message",
        "required": true
      }
    },
    "instruction": {
      "miid_9a4c07e5b312df8641ca": {
        "type": "text",
        "instruction": "Classify the message as low, normal or urgent."
      }
    },
    "status": "activated",
    "created_at": 1789206600
  }
}

Remarque — La création répond 200 et non 201, et ses data et instruction sont des objets indexés par les nouveaux identifiants, et non les tableaux que renvoient les lectures. Relisez l'application avec GET /v1/ai/app/detail/<app_id> si vous avez besoin de la forme habituelle.

Types de champ

Le type que vous envoyez dans data est l'un des noms ci-dessous. Son identifiant est aussi accepté, et c'est l'identifiant que renvoient les lectures.

Les champs document et image ne prennent pas de texte saisi : une exécution fournit un fichier déjà présent dans la bibliothèque de fichiers de votre projet. Voir Exécutions IA.

Types d'instruction

Le type de chaque instruction indique le genre de réponse attendu :

Catégories de tâche

category prend l'un de ces noms (ou son identifiant) : general, summarizing, writing, analyze, solving, decision, excracting, coding, translation, classify, chatting, scoring, embedding. Envoyez les noms exactement tels qu'ils sont écrits ici.

Lister vos applications

GET /v1/ai/app/list renvoie les applications de votre projet, de la plus récente à la plus ancienne, sans les applications supprimées. Il accepte limit et offset.

curl "https://api.ultineo.com/v1/ai/app/list?limit=2" \
  -H "Authorization: Bearer sk-project-YOUR_KEY"

{
  "code": 200,
  "title": "OK",
  "response": {
    "object": "list",
    "data": [
      {
        "id": "mapp_0ceacb46e5b3a99e91b6",
        "object": "app",
        "name": "Support triage",
        "description": "Sorts an inbound support message by urgency.",
        "catalog_category": "",
        "type": "private",
        "status": "activated",
        "model": "modi_c2b7e9a1d3f0a8645c8e",
        "model_library": "mlyi_c2a1e7d9b4f30685c3a3",
        "runs": { "private": 12, "public": 0 },
        "tokens": { "input": 8420, "output": 3115, "total": 11535 },
        "created_at": 1789206600,
        "updated_at": 1789206600
      }
    ],
    "total": 1
  }
}

La liste omet data, instruction et logo : lisez une application pour les obtenir.

Lire une application

GET /v1/ai/app/detail/<app_id> renvoie l'objet complet, y compris les champs d'entrée nécessaires pour lancer une exécution.

curl https://api.ultineo.com/v1/ai/app/detail/mapp_0ceacb46e5b3a99e91b6 \
  -H "Authorization: Bearer sk-project-YOUR_KEY"

{
  "code": 200,
  "title": "OK",
  "response": {
    "id": "mapp_0ceacb46e5b3a99e91b6",
    "object": "app",
    "name": "Support triage",
    "description": "Sorts an inbound support message by urgency.",
    "catalog_category": "",
    "type": "private",
    "status": "activated",
    "logo": "",
    "model": "modi_c2b7e9a1d3f0a8645c8e",
    "model_library": "mlyi_c2a1e7d9b4f30685c3a3",
    "data": [
      {
        "id": "madi_5d8b21c74e0af96b3d15",
        "name": "message",
        "type": "mdti_fdd932b23e1fa82aa942",
        "placeholder": "Paste the message",
        "required": true
      }
    ],
    "instruction": [
      {
        "id": "miid_9a4c07e5b312df8641ca",
        "type": "aiti_d0c8a5e7b2f3a6c4e9d1",
        "instruction": "Classify the message as low, normal or urgent."
      }
    ],
    "runs": { "private": 12, "public": 0 },
    "tokens": { "input": 8420, "output": 3115, "total": 11535 },
    "created_at": 1789206600,
    "updated_at": 1789206600
  }
}

Vous pouvez lire vos propres applications quel que soit leur statut, ainsi que toute application publique activée d'un autre projet. La lecture de l'application publique d'un autre projet masque ce qui appartient à son propriétaire : instruction vaut null et runs.private vaut 0, et tokens indique ce que votre propre projet y a dépensé. Une application qui n'existe pas ou a été supprimée renvoie 404 et App not found. ; l'application privée d'un autre projet renvoie 422 et le message général.

Modifier une application

PATCH /v1/ai/app/detail/<app_id> modifie un ou plusieurs de ces champs de l'une de vos applications. Envoyez-en au moins un.

curl -X PATCH https://api.ultineo.com/v1/ai/app/detail/mapp_0ceacb46e5b3a99e91b6 \
  -H "Authorization: Bearer sk-project-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Support triage (EN)" }'

{
  "code": 200,
  "title": "OK",
  "response": {
    "id": "mapp_0ceacb46e5b3a99e91b6",
    "object": "app",
    "name": "Support triage (EN)",
    "description": "Sorts an inbound support message by urgency.",
    "catalog_category": "",
    "type": "private",
    "status": "activated",
    "model": "modi_c2b7e9a1d3f0a8645c8e",
    "model_library": "mlyi_c2a1e7d9b4f30685c3a3",
    "created_at": 1789206600,
    "updated_at": 1789210200
  }
}

La publication a deux conditions : l'application doit déjà être activée, et elle doit avoir un logo. Retirer une application réussit toujours.