packages/cloud-frontend/content/quickstart.mdx
import { Steps, Tabs, Callout, Cards } from "@/docs/components";
Get your first AI agent running in 5 minutes with elizaOS Cloud.
<Callout type="info"> This guide assumes you have a elizaOS Cloud account. [Sign up here](/login) if you haven't already. </Callout>The fastest way to create and deploy an agent without writing code.
<Steps> ### Navigate to Agent CreatorGo to Dashboard → Agent Creator in the elizaOS Cloud dashboard.
Fill in the basic details:
{
"name": "My Assistant",
"description": "A helpful AI assistant",
"modelProvider": "openai",
"model": "gpt-4o"
}
Add bio and style information to shape your agent's responses:
Click "Deploy" to launch your agent runtime. Test it in the dashboard, then connect it to the full Eliza app for day-to-day chat.
</Steps>Use the Eliza app when you want the complete chat experience for your deployed agent.
<Steps> ### Open AppsGo to Dashboard → Apps and choose the app or device entry for your agent.
Select the deployed agent runtime you want the app to use. Confirm the app has the correct API key or session access.
Open Eliza, select your connected agent, and send a test message. The app chat uses the same hosted runtime you deployed from the dashboard.
</Steps>Integrate elizaOS Cloud directly into your applications.
Navigate to Dashboard → API Keys and create a new key.
# Your API key will look like this:
ELIZA_API_KEY=eliza_xxxxxxxxxxxxxxxxxxxx
<Tabs items={['cURL', 'JavaScript', 'Python']}> <Tabs.Tab>
curl -X POST "https://elizacloud.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://elizacloud.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://elizacloud.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> </Tabs>
<Tabs items={['cURL', 'JavaScript', 'Python']}> <Tabs.Tab>
curl -X POST "https://elizacloud.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://elizacloud.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://elizacloud.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> </Tabs>
Create a local elizaOS project. Cloud deployment and hosted app registration use the dashboard, Cloud API, or SDK endpoints documented in the app and container sections.
<Steps> ### Install the CLIbun add -g elizaos
elizaos create my-cloud-app --template project
cd my-cloud-app
bun install
bun run dev
Configure your local development environment:
# .env
ELIZA_API_KEY=eliza_xxxxxxxxxxxxxxxxxxxx
ELIZA_API_URL=https://elizacloud.ai/api/v1