Skip to main content

Getting Started

Quick guide to integrate with the Nyor API.

Base URL​

https://api.nyor.fun

Get an API key​

Contact the team to request an API key. You'll receive a key in the form sk_live_... once. Store it securely - it cannot be retrieved again.

Security best practices:

  • Never commit API keys to version control
  • Never expose keys in client-side code (browser, mobile apps)
  • Use environment variables or a secrets manager in production
  • Only use the API from server-side or trusted backends over HTTPS

Authentication​

Include your API key in every request using the Authorization header:

Authorization: Bearer sk_live_YOUR_API_KEY

First request​

curl -X POST https://api.nyor.fun/ask \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Hello, what can you help me with?",
    "history": []
  }'

Response:

{
  "response": [
    { "type": "text", "text": "I can help you with..." }
  ],
  "conversationHistory": [...],
  "conversationId": "abc123"
}

Available endpoints​

  • POST /ask — Non-streaming chat (returns complete response)
  • POST /ask/stream — Streaming chat (returns Server-Sent Events)