Ressources pour agents
Documentation lisible par machine, fichiers OpenAPI et exemples prêts à copier pour les agents de code et les workflows de développement.
Points d'entrée lisibles par machine
- /docs/llms.txt fournit aux agents une carte courte et sélectionnée de la documentation de l'API VeriMails.
- /llms-full.txt regroupe la documentation essentielle dans un seul fichier lisible en Markdown.
- /docs.md résume la documentation publique pour les développeurs.
- /openapi.json et le /openapi.yaml décrivent le contrat de l'API.
Docs Markdown
Utilisez ces fichiers pour charger VeriMails dans vos outils de code, vos systèmes de documentation internes ou le contexte de vos prompts.
- Vue d'ensemble de la documentation
- Référence de l'API
- Exemples de code
- Vérification unitaire
- Vérification en masse
- Recherche d'emails
- Codes de résultat
- Gestion des erreurs
Ordre d'implémentation recommandé
Pour une nouvelle intégration, commencez par une requête de vérification unitaire, ajoutez la gestion des erreurs, puis passez aux workflows en masse si vous devez traiter des listes.
POST
/api/verify/single
POST
/api/bulk
POST
/api/find-email