Getting Started

Quick Start

Get up and running with NovaAI in minutes. This guide walks you through the essential steps to create your first project, authenticate with the API, and send your first successful request using the official SDKs.

Create Your First Project

The Quick Start guide is designed to help you integrate NovaAI as quickly as possible. By the end of this guide, you'll have a working API connection and receive your first AI-generated response.

This guide assumes you have a NovaAI account and basic familiarity with the command line and JavaScript.

Before You Begin

Before making your first request, ensure you have the following:

Requirement

Description

NovaAI Account

Create an account to access the Developer Console.

API Key

Generate an API key from your dashboard.

Node.js

Version 18 or later is recommended.

Package Manager

npm, pnpm, yarn, or bun.

Keep your API keys secure. Never expose secret keys in client-side applications or public repositories.

Keep your API keys secure. Never expose secret keys in client-side applications or public repositories.

1

Create a Project

Sign in to the NovaAI Dashboard and create your first project. Every API request is associated with a project, allowing you to manage API keys, monitor usage, and configure billing independently. After creating a project, generate a new API key from the API Keys section.

1

Create a Project

Sign in to the NovaAI Dashboard and create your first project. Every API request is associated with a project, allowing you to manage API keys, monitor usage, and configure billing independently. After creating a project, generate a new API key from the API Keys section.

2

Install the SDK

Install the official NovaAI SDK using your preferred package manager.

npm install @novaai/sdk
2

Install the SDK

Install the official NovaAI SDK using your preferred package manager.

npm install @novaai/sdk

All official SDKs are versioned independently. Always install the latest stable release unless your project requires a specific version.

All official SDKs are versioned independently. Always install the latest stable release unless your project requires a specific version.

3

Configure Your API Key

Store your API key as an environment variable instead of hardcoding it into your application.

NOVA_API_KEY=your_api_key_here
3

Configure Your API Key

Store your API key as an environment variable instead of hardcoding it into your application.

NOVA_API_KEY=your_api_key_here

Property

Description

Variable

NOVA_API_KEY

Scope

Project

Required

Yes

Recommended Storage

Environment Variables

4

Send Your First Request

Create a new file and initialize the NovaAI client.

import { NovaAI } from "@novaai/sdk";
 
const client = new NovaAI({
apiKey: process.env.NOVA_API_KEY,
});
 
const response = await client.chat.create({
model: "nova-chat-4",
messages: [
{
role: "user",
content: "Explain what an API is in one sentence."
}
]
});
 
console.log(response.output);

If the request is successful, the API returns a structured response containing the generated output and metadata.

4

Send Your First Request

Create a new file and initialize the NovaAI client.

import { NovaAI } from "@novaai/sdk";
 
const client = new NovaAI({
apiKey: process.env.NOVA_API_KEY,
});
 
const response = await client.chat.create({
model: "nova-chat-4",
messages: [
{
role: "user",
content: "Explain what an API is in one sentence."
}
]
});
 
console.log(response.output);

If the request is successful, the API returns a structured response containing the generated output and metadata.

Quick Integration Flow

Rendering diagram…

Verify Your Setup

After completing the previous steps, confirm the following:

  • Your SDK is installed successfully.

  • Your API key is stored securely.

  • The client initializes without errors.

  • Your first request returns a successful response.

  • The generated output appears in your terminal or application.

Common Setup Issues

Authentication Failed

Ensure your API key is valid and included in the Authorization header or SDK configuration.

Module Not Found

Verify that the SDK is installed correctly and that your package manager completed the installation successfully.

Environment Variable Not Found

Restart your development server after creating or updating your .env file.

What's Next?

Now that you've successfully connected to NovaAI, you're ready to explore the platform in more depth.

Continue with:

  • Installation - Learn about SDKs, system requirements, and supported environments.

  • Authentication - Understand API keys, project scopes, and secure authentication practices.

  • Your First Request - Dive deeper into request structure, responses, and best practices for interacting with NovaAI.

Was this helpful?

Was this helpful?

Create a free website with Framer, the website builder loved by startups, designers and agencies.