ORYKSAORYKSADevelopers
Obter chaves de API

Conhecimento (Brain)

Ensine ao colaborador de IA o que o negócio vende, como funciona e o que os clientes costumam perguntar.

Enviar páginas

PUT/v1/knowledge/pages

Substitui o conteúdo do site a partir do qual o agente responde. Envie o texto visível de cada página (não HTML). Até 800 páginas, 60.000 caracteres no total. Se você não enviar business_summary, a ORYKSA escreve um a partir das páginas. A saudação e as sugestões do chat são geradas automaticamente, a não ser que o dono as tenha 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},
    ],
})

Ler um site publicado

POST/v1/knowledge/crawl

A ORYKSA lê a página inicial e as páginas internas (até 30), escreve a ficha de fatos do negócio e salva. Sites que só são desenhados no navegador (single page apps) podem devolver pouco texto: nesse caso, envie você as 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 }),
});

Perguntas e respostas

POST/v1/knowledge/faq

Adiciona novas FAQs ou atualiza a resposta de uma pergunta existente (comparada pela pergunta exata). Até 100 itens por chamada.

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

Ler o resumo

GET/v1/knowledge

Devolve o que o agente sabe: número de páginas, caracteres, FAQs e serviços.

AnteriorChatPróximoConta e agente