AIDevKit - AI Suite for Unity
API ReferencesDiscordGlitch9
  • Introduction
    • AI Dev Kit 3.7.0
    • Troubleshooting
    • FAQ
    • Update Logs
      • AI Dev Kit v2
      • AI Dev Kit v1
  • Quick Start
    • API Key Setup
      • OpenAI
      • Google Gemini
      • ElevenLabs
      • OpenRouter
    • Adding Models & Voices
      • Quick Add Guide
      • Creating Snippets
    • Self-Hosting with Ollama
  • Editor Tools
    • Editor Chat
    • Asset Generators
    • Asset Managers
      • Prompt History
      • File Manager
      • Chatbot Manager
      • Assistant Manager
  • GEN Tasks
    • Overview
      • Prefixes
      • Sequence
    • Response
    • Image
    • Video
    • SoundFX
    • Speech
    • Transcript
    • Voice Change
    • Audio Isolation
  • Components
    • Chatbot
    • Chatbot (Assistants API)
    • Realtime Assistant
    • Modules
    • Event Receivers
  • Platform API
    • OpenAI
      • 💬Chat completions
      • 🖼️Image operations
      • 🗣️Text to speech
      • 🎙️Speech to text
        • Recording real-time in Unity
      • 💾Files
      • 🔎Embeddings
      • 🛡️Moderations
      • ⚙️Fine-tuning
      • Assistants API
        • How it works
        • Creating custom functions
        • Creating assistants API
    • Google Gemini
      • 📝System instructions
      • 💬Text generation
      • ⚙️Fine-tuning
      • ▶️Fucntion calling
      • 🔎Embeddings
      • 🛡️Safety
      • 💻Code execution
  • Legacy Documents
    • AI Dev Kit 1.0
      • Preperation
      • Scriptable Toolkits
        • Chat Streamer
        • Image Generator
        • Voice Transcriber
        • Voice Generator
      • Editor Tools
      • Troubleshooting (Legacy)
        • ❗Build Error: The name 'UnityMenu' does not exist in the current context
        • ❗The type or namespace name 'AndroidJavaObject' could not be found
        • ❗The type or namaspace name 'Plastic' does not exist
        • ❗Build Error: The name 'Asset Database' does not exist in the current context
        • ❗'ModelData.Create(Provider, string, UnixTime?, string)': not all code paths return a value
      • Code Generators
        • C# Script Generator
        • Unity Component Generator
    • AI Dev Kit 2.0
      • Event Handlers
      • Editor Chat
      • Editor Vision (TTI, ITI)
      • Editor Speech (TTS)
      • Management Tools
        • Prompt History Viewer
        • AI Model Manager
        • TTS Voice Manager
        • OpenAI File Manager
        • OpenAI Assistant Manager
        • ElevenLabs Voice Library
Powered by GitBook
On this page
  • What is an API key and why do I need it?
  • How do I get my API key?
  • Where do I paste my API key in Unity?
  • Can I use the same API key for multiple projects?
  • Is my API key safe in a Unity project?
  • What happens if I lose my API key?
  1. Quick Start

API Key Setup

Learn the basics of API keys

PreviousAI Dev Kit v1NextOpenAI

Last updated 19 days ago

What is an API key and why do I need it?

An API key is a unique string of characters that identifies your app to an external AI service like OpenAI, Gemini, or ElevenLabs. It works like a secure password that allows your app to access models for text generation, image creation, speech synthesis, and more.

Without an API key, the AI Dev Kit cannot communicate with the AI provider — it's required for all runtime requests.


How do I get my API key?

See each provider section under Provider Setup for step-by-step instructions.

OpenAI

Google Gemini

ElevenLabs

OpenRouter


Where do I paste my API key in Unity?

Go to Edit > Preferences > AI Dev Kit > [Each Provider Tab] then paste your API key into the [API key] field.


Can I use the same API key for multiple projects?

Yes.

Most providers — including OpenAI — allow you to reuse a single API key across multiple projects. However, keep in mind that all usage will count toward the same billing account and rate limits. If you're working on separate commercial products, it's a good idea to generate and track separate keys.


Is my API key safe in a Unity project?

Yes.

AI Dev Kit supports API Key Encryption (AES) through the Preferences window under each provider tab.

Go to Edit > Preferences > AI Dev Kit > [Each Provider Tab] then press the little key button on the right side of your API key.


What happens if I lose my API key?

If you lose your API key, you won’t be able to authenticate requests to the AI provider. Most providers (like OpenAI) allow you to regenerate a new key from your account dashboard. You cannot recover the original key once it's lost, so make sure to store it in a password manager or reissue it when needed.