Quickstart — 5 minutes
Copier-coller ready. Remplacez
YOUR_API_KEYet exécutez.
1. Obtenir une clé sandbox
curl -X POST https://pyxaura.com/docs/sandbox_key
{
"api_key": "pyx_test_abc12345_xxxxxxxx...",
"expires_in": 86400,
"demo_space_id": "spc_1"
}
2. Créer un space
export KEY="YOUR_API_KEY"
curl -X POST https://pyxaura.com/api/v1/spaces \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Mon premier space", "external_ref": "quickstart-demo", "locale": "fr"}'
{
"space": {
"id": "spc_9f2",
"name": "Mon premier space",
"documents_count": 0
}
}
3. Indexer un document
export SPACE="spc_9f2"
curl -X POST https://pyxaura.com/api/v1/spaces/$SPACE/documents \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "CGV — Politique de retour",
"content": "Les retours sont acceptés sous 30 jours après réception de la commande. Contactez support@example.com pour initier un retour.",
"external_id": "cgv-retours"
}'
{
"document": {
"id": "doc_88",
"status": "pending",
"indexing": "queued"
}
}
L'indexation est asynchrone. Attendez quelques secondes puis vérifiez le statut :
curl https://pyxaura.com/api/v1/spaces/$SPACE/documents/doc_88 \
-H "Authorization: Bearer $KEY"
Quand "status": "indexed", le document est prêt.
4. Poser une question
curl -X POST https://pyxaura.com/api/v1/spaces/$SPACE/query \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{"question": "Quel est le délai de retour ?"}'
{
"answer": "Le délai de retour est de 30 jours [1].",
"sources": [
{ "index": 1, "document_id": "doc_88", "title": "CGV — Politique de retour" }
],
"usage": {
"input_tokens": 245,
"output_tokens": 22,
"model": "claude-3-5-haiku-20241022",
"latency_ms": 890,
"cost": { "amount": 0.0008, "currency": "EUR" }
}
}
5. Streaming SSE (optionnel)
curl -X POST https://pyxaura.com/api/v1/spaces/$SPACE/query \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-H "Accept: text/event-stream" \
-d '{"question": "Quel est le délai de retour ?"}' \
--no-buffer
event: status
data: {"stage":"retrieving"}
event: delta
data: {"text":"Le délai "}
event: delta
data: {"text":"de retour est de 30 jours [1]."}
event: done
data: {"message_id":null,"answer":"...","sources":[...],"usage":{...}}
🎉 Vous avez réussi votre premier appel Pyxaura.
Consultez les [guides détaillés](./guides/) pour aller plus loin.