ORYKSAORYKSADevelopers
Obtener claves de API

Conocimiento (Brain)

Enséñale al empleado de IA qué vende el negocio, cómo funciona y qué suelen preguntar los clientes.

Enviar páginas

PUT/v1/knowledge/pages

Reemplaza el contenido del sitio a partir del cual responde el agente. Envía el texto visible de cada página (no HTML). Hasta 800 páginas, 60 000 caracteres en total. Si no envías business_summary, ORYKSA escribe uno a partir de las páginas. El saludo y las sugerencias del chat se generan automáticamente, salvo que el dueño los haya personalizado.

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},
    ],
})

Leer un sitio publicado

POST/v1/knowledge/crawl

ORYKSA lee la página de inicio y las páginas internas (hasta 30), escribe la ficha de datos del negocio y la guarda. Los sitios que solo se dibujan en el navegador (single page apps) pueden devolver poco texto: en ese caso envía tú las páginas.

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 }),
});

Preguntas y respuestas

POST/v1/knowledge/faq

Añade FAQs nuevas o actualiza la respuesta de una pregunta existente (comparada por la pregunta exacta). Hasta 100 elementos por llamada.

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."},
]})

Leer el resumen

GET/v1/knowledge

Devuelve lo que sabe el agente: número de páginas, caracteres, FAQs y servicios.

AnteriorChatSiguienteCuenta y agente