Quick Start

Quickly get started with Synoria today! This guide covers the key steps to authenticate your app, initialize the SDK, and generate your first AI response. By the end, you'll grasp the basic request and response workflow used across the platform. This structure is applicable for chat experiences, coding assistants, AI agents, content generation tools, or custom workflows, allowing easy expansion as your needs evolve.

Initialize the Client

To create a Synoria client, simply utilize your unique API key. This client serves as the primary gateway for all your API requests, efficiently managing authentication, configuration, and ensuring seamless communication with the Synoria platform.

import { Synoria } from "@Synoria-ai/sdk";

const client = new Synoria({
  apiKey: process.env.SYNORIA_API_KEY,
  organization: "creative-studio",
  timeout: 30000,
});

console.log("Synoria client initialized.");

Generate Your First Response

Once the client is ready, send your first prompt using the Chat API. Each request specifies a model and includes one or more messages. The API returns a structured response that can be displayed directly in your application or used as input for additional workflows.

import { Synoria } from "@Synoria-ai/sdk";

const client = new Synoria({
  apiKey: process.env.SYNORIA_API_KEY,
});

async function generateResponse() {
  const response = await client.chat.generate({
    model: "axiom-1",
    temperature: 0.7,
    messages: [
      {
        role: "user",
        content: "Explain artificial intelligence in simple terms."
      }
    ]
  });

  console.log(response.output);
}

generateResponse();

Understanding the Response

Every successful request returns structured data that includes the generated output along with valuable metadata. This information can be effectively utilized to display results, monitor usage patterns, or create even richer application experiences for users.

{
  "id": "chat_01H8YZ9",
  "model": "axiom-1",
  "output": "Artificial intelligence enables computers to perform tasks that normally require human intelligence.",
  "usage": {
    "prompt_tokens": 18,
    "completion_tokens": 24,
    "total_tokens": 42
  }
}

Continue Building

Congratulations—you've completed your first AI request with Synoria. Next, you'll learn how to authenticate requests securely using API keys and variables, ensuring every application communicates safely with the Synoria platform.