Skip to content

quickstart.mdx

Latest commit

 

History

History
377 lines (324 loc) · 9.93 KB

quickstart.mdx

File metadata and controls

377 lines (324 loc) · 9.93 KB
title Quickstart
description Get started with elizaOS Cloud in 5 minutes. Deploy your first AI agent and start building.

import { Steps, Tabs, Callout, Cards } from "nextra/components";

Quickstart

Stable

Get your first AI agent running in 5 minutes with elizaOS Cloud.

This guide assumes you have a elizaOS Cloud account. [Sign up here](/login) if you haven't already.

Choose Your Path

Using the Agent Creator

The fastest way to create an agent without writing code.

### Navigate to Agent Creator

Go to Dashboard → Agent Creator in the elizaOS Cloud dashboard.

Configure Your Agent

Fill in the basic details:

{
  "name": "My Assistant",
  "description": "A helpful AI assistant",
  "modelProvider": "openai",
  "model": "gpt-4o"
}

Customize Personality

Add bio and style information to shape your agent's responses:

  • Bio: Background information and expertise
  • Style: Communication tone and formatting preferences
  • Topics: Areas of knowledge

Deploy & Test

Click "Deploy" to launch your agent. Test it in the built-in chat interface or via API.

Using the API

Integrate elizaOS Cloud directly into your applications.

Step 1: Get Your API Key

Navigate to Dashboard → API Keys and create a new key.

# Your API key will look like this:
ELIZA_API_KEY=ek_live_xxxxxxxxxxxxxxxxxxxx

Step 2: Create an Agent

<Tabs items={['cURL', 'JavaScript', 'Python']}> <Tabs.Tab>

curl -X POST "https://cloud.milady.ai/api/v1/app/agents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Assistant",
    "bio": "A helpful AI assistant"
  }'

</Tabs.Tab> <Tabs.Tab>

const response = await fetch('https://cloud.milady.ai/api/v1/app/agents', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'My Assistant',
    bio: 'A helpful AI assistant',
  }),
});

const agent = await response.json();
console.log('Created agent:', agent.agent.id);

</Tabs.Tab> <Tabs.Tab>

import requests

response = requests.post(
    'https://cloud.milady.ai/api/v1/app/agents',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={
        'name': 'My Assistant',
        'bio': 'A helpful AI assistant',
    },
)

agent = response.json()
print(f'Created agent: {agent["agent"]["id"]}')

</Tabs.Tab>

Step 3: Send a Message

<Tabs items={['cURL', 'JavaScript', 'Python']}> <Tabs.Tab>

curl -X POST "https://cloud.milady.ai/api/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "YOUR_AGENT_ID",
    "messages": [
      {"role": "user", "content": "Hello! What can you help me with?"}
    ]
  }'

</Tabs.Tab> <Tabs.Tab>

const response = await fetch('https://cloud.milady.ai/api/v1/chat/completions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model: 'YOUR_AGENT_ID',
    messages: [
      { role: 'user', content: 'Hello! What can you help me with?' }
    ],
  }),
});

const completion = await response.json();
console.log(completion.choices[0].message.content);

</Tabs.Tab> <Tabs.Tab>

response = requests.post(
    'https://cloud.milady.ai/api/v1/chat/completions',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={
        'model': 'YOUR_AGENT_ID',
        'messages': [
            {'role': 'user', 'content': 'Hello! What can you help me with?'}
        ],
    },
)

completion = response.json()
print(completion['choices'][0]['message']['content'])

</Tabs.Tab>

Using the CLI

Deploy agents from your local elizaOS project.

### Install the CLI 
bun add -g @elizaos/cli

Login to elizaOS Cloud

elizaos login

Deploy Your Agent

elizaos deploy --character ./character.json

This uploads your character configuration and deploys it to elizaOS Cloud.

Environment Variables

Configure your local development environment:

# .env
ELIZA_API_KEY=ek_live_xxxxxxxxxxxxxxxxxxxx
ELIZA_API_URL=https://cloud.milady.ai/api/v1

What's Next?