Get Started

If you're new to Lumyx AI, start here to learn the essentials and make your first API call.

Quick Start Guide

Follow these steps to get up and running with Lumyx AI in minutes.

Create an API key

Generate your first API key to authenticate your requests.

Make your first request

Send a chat completion request to start interacting with Lumyx AI.

Explore advanced features

Try agents, different models, and customize parameters.

Step 1: Create an API Key

API keys are used to authenticate your requests to Lumyx AI. Each key can be customized with specific permissions and rate limits.

Keep your API keys secure

Never share your API keys publicly or store them in client-side code. Use environment variables to keep them secure.

Create your first API key

Go to the API Keys dashboard
Click the "Create New API Key" button
Give your key a descriptive name (e.g., "My First API Key")
Set appropriate rate limits for your use case
Click "Create API Key"
Copy the generated key and store it securely

Create API Key

Step 2: Make Your First Request

Once you have an API key, you can start making requests to Lumyx AI. Here's a simple example using curl:

Example Request

curl -X POST https://api.lumyx-ai.site/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "nova_1_1",
    "messages": [
      {
        "role": "user",
        "content": "Hello, Lumyx AI! How are you today?"
      }
    ],
    "max_tokens": 2000,
    "temperature": 0.7
  }'

Example Response

JSON Response

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1699896516,
  "model": "nova_1_1",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! I'm doing well, thank you for asking..."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 12,
    "completion_tokens": 31,
    "total_tokens": 43
  }
}

Try it in the playground

Want to test this without writing code? Use our API Playground to make requests interactively.