GET STARTEDDeveloper quickstart

Developer quickstart

Learn how to make your first Novax Studio API request.

The Novax Studio API provides a simple interface to state-of-the-art AI models and features. Follow this guide to learn how to integrate AI-powered customer service into your application.

Create an API key

Create an API key in the dashboard, which you'll use to securely access the API.

Store the key as a managed secret and pass it to the SDKs either as an environment variable via an .env file.

.env

NOVAX_API_KEY=<your_api_key_here>

Install the SDK

We'll also use the dotenv library to load our API key from an environment variable.

bash

npm install novax-studio dotenv

Make your first request

Create a new file named customer-support.ts and add the following code to create a customer support agent:

customer-support.ts

import { NovaxClient } from 'novax-studio';
import * as dotenv from 'dotenv';

dotenv.config();

const client = new NovaxClient({
  apiKey: process.env.NOVAX_API_KEY
});

async function handleCustomerQuery() {
  const response = await client.agent.create({
    type: 'customer-support',
    message: "I need help with my recent order #12345",
    context: {
      customerId: "cust_abc123",
      orderId: "order_12345",
      tier: "premium"
    },
    capabilities: [
      'order-tracking',
      'refunds',
      'technical-support'
    ]
  });

  console.log('Agent Response:', response.message);
  console.log('Confidence:', response.confidence);
  console.log('Suggested Actions:', response.suggestedActions);
}

handleCustomerQuery();

Run the code

bash

npx ts-node customer-support.ts

Explore our developer guides

API Reference

Complete API documentation

Webhooks

Real-time event notifications

Integrations

Connect with your tools

Best Practices

Tips for production

Need help?

Our support team is here to help you succeed