Vue générale de API
On this page
Le Curriculo API est un API RESTful à https://api.curriculo.me/public qui donne un accès programmatique aux mêmes moteurs de résumé, d'évaluation, de langage et d'interview qui fonctionnent à l'intérieur du produit Curriculo. Les demandes sont JSON ou multipart/form-data; les réponses sont JSON.
Nouveau dans le Curriculo ? Commencez par le Quickstart: créer un compte, émettre une clé et effectuer un appel.
Préalabilités
- Un compte Développeur Console
- Une clé API créée dans Console → API
Des API disponibles
| API | L'opération | Ce qu'il fait | Prix |
|---|---|---|---|
| Parsée | POST /parse/ | Lisez les CV (PDF ou DOCX) en JSON structuré. | $0.01 par demande |
| Évaluer | POST /evaluate/ | Points de résumé par rapport à un emploi: aptitude, analyse de l'ajustement, lacunes. | $0.01 par demande |
| Les emplois | POST /jobs/ | Facultatif. Enregistrer une description de poste une fois et réutiliser son job_id. | Gratuit |
| Traduction | POST /translate/ | Traduction des chaînes ou des documents PDF et DOCX. | $0.01 par demande (voir prix ) |
| Détecter le langage | POST /detect-language/ | code ISO 639-1 pour un texte ou jusqu'à 200. | $0.001 par demande |
| Résumé de l'entrevue | POST /summary/ | Les points forts, les balises rouges, les compétences et une recommandation d'embauche à partir d'une transcription ou d'un enregistrement. | 0.01, plus 0.002 par minute pour les enregistrements |
| Transcrivez | POST /transcribe/ | Une transcription d'un enregistrement, pas de résumé. | $0.002 par minute |
| Rapidement | POST /prompt/ | Générer, éditer, traduire ou remettre en question le CV attaché à votre carte d'identité. C'est très étonnant. | $0.01 par demande |
| Interview de dépistage | POST /screening-interview | Interviews enregistrées avec des rappels signés. | $0.02 par invitation envoyée |
tâches de fond
Parser, évaluer, résumer, transcrire et traduire fonctionne également en arrière-plan: POST /{op}/async répond à 202 avec un task_id à la fois, et vous collectez le résultat avec GET /{op}/tasks/{task_id} ou le recevez par appel-retour signé. Voir Traitement des antécédents et rappels.
Les chemins
Les opérations synchrones se terminent par une tranche arrière (/parse/). Les pistes de tâches de fond (/parse/async,/parse/tasks/{task_id}) et les pistes de dépistage (/screening-interview) sont documentées sans une.
Pour les spécifications complètes, voir le document OpenAPI, ou parcourir Swagger UI ou ReDoc.
L'authentification
| Titre | La valeur | Règlement |
|---|---|---|
Authorization | Bearer key_<id>_<secret>, votre clé API de la console | Oui, c'est vrai |
Content-Type | application/json ou multipart/form-data, selon l' opération | Oui, sur demande avec un corps |
Une clé de console autorise toutes les opérations, immédiatement. Il n'y a pas de références à chaque point final, pas de champs d'application et rien à activer. Voir l'authentification .
Il n'y a pas d'en-tête de version API. La surface est versionnée par chemin, et les modifications additives (nouveaux champs optionnels, nouvelles opérations) se font sans casser les appels existants.
Base URL
https://api.curriculo.me/publicPointez votre client à cette base et ajouter le chemin d'opération, par exemple https://api.curriculo.me/public/parse/.
- Une carte d'identité partout. Une seule clé de console authentifie chaque opération.
- Limits appliqués par clé, , donc une intégration bruyante ne peut pas dépenser le budget d'un autre.
- Les demandes ratées ne sont jamais facturées. A
4xxou5xxne vous coûte rien.
La production est le seul environnement publié.
Format de demande et de réponse
Voir Demande et réponse. La version courte:
/parse/,/evaluate/,/prompt/et prise de/transcribe/multipart/form-data./detect-language/et prise de/jobs/application/json./translate/et/summary/prennentapplication/json, oumultipart/form-datapour envoyer des documents ou des enregistrements.- Un document peut être jusqu'à 10 MB. Un corps de requête peut contenir jusqu'à 12 MB, à l'exception de
/summary/, qui accepte des enregistrements allant jusqu'à 100 MB. - Envoyez un objet, prenez l'objet de cet objet. Envoyez plusieurs, obtenez les résultats dans l'ordre des entrées.
La mise en lots
Il n'y a pas de point final séparé pour le lot: la liste est le lot. Jusqu'à 10 documents par demande pour analyse et évaluation, jusqu'à 200 textes pour traduction et détection des langues. Voir Batchage.
Limits de taux
| Limite | La valeur |
|---|---|
| Par clé API | 600 demandes par minute |
| Par adresse IP | 2 000 demandes par minute |
| Travail lourd (analyse, évaluation, résumé) | 3 opérations à la fois, partagées sur le service; requêtes supplémentaires en file d'attente |
| Demande de délai | 300 secondes |
Les erreurs
Les erreurs sont JSON et portent le statut de HTTP qui compte. Chaque réponse porte une en-tête X-Curriculo-Request-Id à citer pour soutenir. Voir Erreurs.
Gestion de votre compte
Les clés, l'utilisation et la facturation sont gérées dans la console de développement . Votre clé API travaille à l'embauche. Il ne peut délibérément pas fabriquer des clés ou modifier la facturation, donc une clé fuite ne peut jamais devenir un contrôle du compte.
Les prochaines étapes
- Quickstart: compte, clé, premier appel en trois étapes.
- Traitement en arrière-plan et rappels: longs travaux sans tenir une connexion ouverte.
- SDK du client: générer un client typé à partir de la spécification OpenAPI.
- API référence: chaque champ pour chaque opération.
Updated