Quickstart

Generate a key, ask your agent a question and teach it something new in 5 minutes.

1. Generate a test key

In the dashboard, go to Developers → API keys → Generate key. Choose the Test environment and the scopes you need. For this guide, check agents:read, knowledge:read and knowledge:write.

The key is shown only once. Store it somewhere safe, such as your server's environment variables:

bash

export NEVOX_API_KEY="nvx_sk_test_..."

Important: secret keys (nvx_sk_...) are for the server only. Never put a secret key in browser or app code. For the front end, use the session token.

2. List your agents

bash

curl https://api.nevox.ai/v1/agents \
  -H "Authorization: Bearer $NEVOX_API_KEY"

json

{
  "data": [
    {
      "id": "agt_8f2k1x",
      "name": "Clinic Support",
      "language": "en-US",
      "status": "active",
      "created_at": "2026-10-02T13:10:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

3. Ask the knowledge a direct question

bash

curl https://api.nevox.ai/v1/agents/agt_8f2k1x/ask \
  -H "Authorization: Bearer $NEVOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "question": "How much is a follow-up visit?" }'

json

{
  "answered": true,
  "answer": "A follow-up visit costs $49.00 and must take place within 30 days of the first visit.",
  "confidence": "high",
  "sources": [
    { "type": "service", "id": "svc_ret01", "title": "Follow-up visit" }
  ]
}

If the agent doesn't know, it doesn't make things up: it returns "answered": false and you decide what to do.

4. Teach the agent something new

bash

curl https://api.nevox.ai/v1/agents/agt_8f2k1x/knowledge \
  -H "Authorization: Bearer $NEVOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "faq",
    "question": "Do you have parking?",
    "answer": "Yes, free parking in the basement garage.",
    "external_id": "faq-parking"
  }'

The agent starts using the answer on every channel right away. Sending it again with the same external_id updates the item instead of duplicating it.

5. Go to production

When everything is working, generate an nvx_sk_live_... key and swap the environment variable. Test keys give real answers, but they don't count toward the plan allowance and are limited to 20 requests per minute.

Where to go next

Knowledge: items, internal knowledge and the service list.
Authentication: scopes and environments.
Conversations: the chat with your own interface, with Nevox as the brain.
Webhooks: get notified of handoffs to a human.
Errors, limits and conventions: what to do for each error.