Alloovium

Documentation développeur

Construire sur Alloovium

API REST publique v2 et serveur Model Context Protocol pour l'intelligence documentaire. Tout ce dont vous avez besoin pour intégrer le vault, le chat, les workflows et le remplissage de templates Alloovium dans votre propre produit ou agent LLM.

URL de base

Tous les endpoints de l'API v2 en production sont servis sous URL de base. Un environnement de staging distinct est disponible pour la validation pré-production ; utilisez l'URL de base de staging listée dans le bloc OpenAPI servers en direct ou fournie avec vos identifiants de staging. Chaque requête doit utiliser HTTPS.

Console développeur

Créez des clés API de test et de production, enregistrez des clients OAuth, et surveillez votre allocation mensuelle de crédits développeur depuis path. Les espaces de travail gratuits et d'essai démarrent avec des crédits sandbox afin que vous puissiez valider les intégrations avant de passer au trafic payant.

Démarrer

Démarrage rapide

Créez votre première clé API et effectuez un appel en moins de cinq minutes.

Authentification

Clés API, OAuth 2.1 avec PKCE, Dynamic Client Registration, scopes.

Référence API

Référence Scalar interactive générée depuis la spec OpenAPI 3.1 construite manuellement.

Console développeur

Créez des clés API, gérez les clients OAuth et suivez vos 100 $ de crédits de démarrage gratuits.

Concepts fondamentaux

Chaque capability — vault CRUD, chat, workflows, templates, meta — utilise les mêmes conventions. Apprenez-les une fois et vous pouvez tout appeler.

Limites de débit

Token buckets, capacité de burst, quatre niveaux, headers X-RateLimit, conseils de retry.

Erreurs

Enveloppe RFC 7807 problem-detail, codes d'erreur stables, IDs de requête.

Idempotence

Retentez les mutations en toute sécurité avec Idempotency-Key. Fenêtre de replay de 24 heures.

Pagination

Enveloppe de pagination par curseur partagée par chaque endpoint de liste.

Capabilities

Dix-sept capabilities regroupées en cinq domaines. Chacune est exposée à la fois comme endpoint REST et comme outil MCP, depuis une seule entrée de registre — les deux surfaces ne divergent jamais.

Projets

Projets, documents, uploads et recherche hybride sémantique + par mots-clés.

Chat

Posez des questions ancrées dans votre vault. Streaming et non-streaming.

Workflows

Listez les workflows, démarrez des exécutions et interrogez le statut des exécutions pour les sorties.

Templates

Remplissez des templates DOCX à partir des preuves du projet. Schéma upload + interrogation.

Meta

Whoami, découverte de scope et introspection des identifiants.

Serveur MCP

Exposez chaque capability comme outil Model Context Protocol pour les agents LLM.

Cas d'usage

Guides d'intégration de bout en bout pour des workflows de construction réels — avec du code Python fonctionnel, des appels API réalistes et des conseils de déploiement. Commencez ici si vous construisez une nouvelle intégration.

Aperçu des cas d'usage

Parcourez les six modèles d'intégration avec les niveaux de difficulté et les estimations de temps.

Pipeline d'intelligence contractuelle

Extrayez obligations, conditions de paiement et jalons — poussez les données structurées vers Procore ou Jira.

Vérificateur de conformité sous-traitants

Vérifiez les certificats d'assurance et licences par rapport aux exigences du projet avant la mobilisation.

Rapports de projet automatisés

Planifiez des rapports hebdomadaires depuis votre vault de documents, livrés sur Slack ou par email.

Comment tout s'articule

La surface publique d'Alloovium est construite sur un registre de capabilities. Chaque opération est déclarée une seule fois et automatiquement montée comme :

  • Un endpoint REST avec schéma OpenAPI 3.1, limitation de débit et application des scopes.
  • Un outil MCP avec le même schéma d'entrée/sortie pour les agents LLM.
  • Une entrée de journal d'audit taguée avec le nom de la capability pour chaque appel.

La spec OpenAPI sur path est la référence machine canonique. Le navigateur Scalar sur /developers/api-reference vous permet d'essayer chaque endpoint de manière interactive.

Versionnage et stabilité

L'API publique est en v2. Nous nous engageons sur le contrat de stabilité suivant :

  • Les champs code d'erreur sont stables — nous ne les renommerons jamais silencieusement.
  • Les changements cassants arrivent avec un nouveau préfixe de version, jamais à l'intérieur de v2.
  • Les changements additifs (nouveaux champs optionnels, nouvelles capabilities) peuvent arriver à tout moment.
  • Les endpoints dépréciés fonctionnent pendant au moins 90 jours avec un header header.

Consultez le changelog pour les ajouts et dépréciations.

Obtenir de l'aide

Contactez email avec votre field (retourné dans chaque réponse d'erreur) et nous pouvons tracer n'importe quel appel de bout en bout. Pour les rapports de sécurité, envoyez un email à security.