ORYKSAORYKSADéveloppeurs
Obtenir des clés API

Connaissance (Cerveau)

Apprenez à l'employé IA ce que l'entreprise vend, comment elle fonctionne et ce que les clients demandent habituellement.

Envoyer des pages

PUT/v1/knowledge/pages

Remplace le contenu du site utilisé par l'agent pour répondre. Envoyez le texte visible de chaque page (pas le HTML). Jusqu'à 800 pages, 60 000 caractères au total. Si vous n'envoyez pas business_summary, ORYKSA en rédige un à partir des pages. Le message d'accueil et les suggestions du chat sont générés automatiquement, sauf si le propriétaire les a personnalisés.

curl -X PUT https://api.oryksa.com/v1/knowledge/pages \
  -H "Authorization: Bearer oryk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "site_url": "https://quintadovale.pt",
    "business_summary": "Family winery in the Douro. Tastings 15 EUR, Mon-Fri 9-16h.",
    "pages": [
      {"title": "Home", "url": "https://quintadovale.pt/", "content": "Visible text of the page..."},
      {"title": "Visits", "url": "https://quintadovale.pt/visits", "content": "..."}
    ]
  }'
await fetch("https://api.oryksa.com/v1/knowledge/pages", {
  method: "PUT",
  headers: { Authorization: "Bearer " + key, "Content-Type": "application/json" },
  body: JSON.stringify({
    site_url: "https://quintadovale.pt",
    pages: [
      { title: "Home", url: "https://quintadovale.pt/", content: homeText },
      { title: "Visits", url: "https://quintadovale.pt/visits", content: visitsText },
    ],
  }),
});
requests.put(f"https://api.oryksa.com/v1/knowledge/pages", headers=H, json={
    "site_url": "https://quintadovale.pt",
    "pages": [
        {"title": "Home", "url": "https://quintadovale.pt/", "content": home_text},
        {"title": "Visits", "url": "https://quintadovale.pt/visits", "content": visits_text},
    ],
})

Lire un site en direct

POST/v1/knowledge/crawl

ORYKSA lit la page d'accueil et les pages internes (jusqu'à 30), rédige la fiche d'entreprise et la stocke. Les sites qui ne s'affichent que dans le navigateur (applications monopage) peuvent retourner peu de texte : envoyez alors les pages vous-même.

curl https://api.oryksa.com/v1/knowledge/crawl \
  -H "Authorization: Bearer oryk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://quintadovale.pt", "max_pages": 20}'
await fetch("https://api.oryksa.com/v1/knowledge/crawl", {
  method: "POST",
  headers: { Authorization: "Bearer " + key, "Content-Type": "application/json" },
  body: JSON.stringify({ url: "https://quintadovale.pt", max_pages: 20 }),
});

Questions et réponses

POST/v1/knowledge/faq

Ajoute de nouvelles FAQ ou met à jour la réponse d'une question existante (correspondance exacte de la question). Jusqu'à 100 éléments par appel.

curl https://api.oryksa.com/v1/knowledge/faq \
  -H "Authorization: Bearer oryk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {"question": "Do you ship abroad?", "answer": "Yes, to the whole EU. Delivery in 3 to 5 working days."},
      {"question": "Is parking available?", "answer": "Yes, free parking next to the winery."}
    ]
  }'
requests.post(f"https://api.oryksa.com/v1/knowledge/faq", headers=H, json={"items": [
    {"question": "Do you ship abroad?", "answer": "Yes, to the whole EU. Delivery in 3 to 5 working days."},
]})

Lire le résumé

GET/v1/knowledge

Retourne ce que l'agent sait : nombre de pages, caractères, FAQ et services.

PrécédentChatSuivantCompte et agent