wehub-resource-sync
426e9eeabd
Voice Workbench / headless workbench (mocked backends) (push) Has been cancelled
Voice Workbench / real acoustic lane (nightly, provisioned only) (push) Has been cancelled
ci / test (push) Has been cancelled
ci / lint-and-format (push) Has been cancelled
ci / build (push) Has been cancelled
ci / dev-startup (push) Has been cancelled
gitleaks / gitleaks (push) Has been cancelled
Markdown Links / Relative Markdown Links (push) Has been cancelled
Quality (Extended) / Homepage Build (PR smoke) (push) Has been cancelled
Quality (Extended) / Comment-only diff guard (push) Has been cancelled
Quality (Extended) / Format + Type Safety Ratchet (push) Has been cancelled
Quality (Extended) / Develop Gate (secret scan + UI determinism) (push) Has been cancelled
Quality (Extended) / Develop Gate (lint) (push) Has been cancelled
Chat shell gestures / Chat shell gesture + parity e2e (push) Has been cancelled
Cloud Gateway Discord / Test (push) Has been cancelled
Benchmark Bridge Tests / benchmark (bunx @biomejs/biome check packages/lifeops-bench/src, benchmark-lint) (push) Has been cancelled
Benchmark Bridge Tests / benchmark (bunx vitest run --config packages/lifeops-bench/vitest.config.ts --root packages/lifeops-bench --passWithNoTests, benchmark-tests) (push) Has been cancelled
Build Agent Image / build-and-push (push) Has been cancelled
Dev Smoke / bun run dev onboarding chat (push) Has been cancelled
Dev Smoke / Vite HMR dependency-level smoke (push) Has been cancelled
Electrobun Submodule Guard / electrobun gitlink is fetchable (push) Has been cancelled
Publish @elizaos/example-code / check_npm (push) Has been cancelled
Publish @elizaos/example-code / publish_npm (push) Has been cancelled
Publish @elizaos/plugin-elizacloud / verify_version (push) Has been cancelled
Publish @elizaos/plugin-elizacloud / publish_npm (push) Has been cancelled
Sandbox Live Smoke / Sandbox live smoke (push) Has been cancelled
Snap Build & Test / Build Snap (amd64) (push) Has been cancelled
Snap Build & Test / Build Snap (arm64) (push) Has been cancelled
Test Packaging / elizaos CLI global-install smoke (node + bun) (push) Has been cancelled
Cloud Gateway Webhook / Test (push) Has been cancelled
Cloud Tests / lint-and-types (push) Has been cancelled
Cloud Tests / unit-tests (push) Has been cancelled
Cloud Tests / integration-tests (push) Has been cancelled
Cloud Tests / e2e-tests (push) Has been cancelled
CodeQL Advanced / Analyze (javascript-typescript) (push) Has been cancelled
Deploy Apps Worker (Product 2) / Determine environment (push) Has been cancelled
Deploy Apps Worker (Product 2) / Deploy apps worker to apps-control host (${{ needs.determine-env.outputs.environment }}) (push) Has been cancelled
Deploy Eliza Provisioning Worker / Determine environment (push) Has been cancelled
Deploy Eliza Provisioning Worker / Deploy worker to Hetzner host (${{ needs.determine-env.outputs.environment }} @ ${{ needs.determine-env.outputs.deployment_sha }}) (push) Has been cancelled
Dev Smoke / Classify changed paths (push) Has been cancelled
supply-chain / sbom (push) Has been cancelled
supply-chain / vulnerability-scan (push) Has been cancelled
Build, Push & Deploy to Phala Cloud / build-and-push (push) Has been cancelled
Test Packaging / Validate Packaging Configs (push) Has been cancelled
Test Packaging / Build & Test PyPI Package (push) Has been cancelled
Test Packaging / PyPI on Python ${{ matrix.python }} (push) Has been cancelled
Test Packaging / Pack & Test JS Tarballs (push) Has been cancelled
UI Fixture E2E / ui-fixture-e2e (push) Has been cancelled
UI Fixture E2E / fixture-e2e (push) Has been cancelled
UI Story Gate / story-gate (push) Has been cancelled
vault-ci / test (macos-latest) (push) Has been cancelled
vault-ci / test (ubuntu-latest) (push) Has been cancelled
vault-ci / test (windows-latest) (push) Has been cancelled
vault-ci / app-core wiring tests (push) Has been cancelled
verify-patches / verify patches/CHECKSUMS.sha256 (push) Has been cancelled
Voice Benchmark Smoke / voice-emotion fixture smoke (push) Has been cancelled
Voice Benchmark Smoke / voiceagentbench fixture smoke (push) Has been cancelled
Voice Benchmark Smoke / voicebench-quality unit smoke (push) Has been cancelled
Voice Benchmark Smoke / voicebench TypeScript unit (no audio) (push) Has been cancelled
Voice Benchmark Smoke / voice bench smoke summary (push) Has been cancelled
Windows CI / windows ([bun run --cwd packages/app-core test bun run --cwd packages/elizaos test bun run --cwd packages/cloud/shared test], app-and-cli) (push) Has been cancelled
Windows CI / windows ([bun run --cwd packages/scenario-runner test bun run --cwd packages/vault test bun run --cwd packages/security test bun run --cwd plugins/plugin-coding-tools test], framework-packages) (push) Has been cancelled
Windows CI / windows ([bun run --cwd plugins/plugin-elizacloud test bun run --cwd plugins/plugin-discord test bun run --cwd plugins/plugin-anthropic test bun run --cwd plugins/plugin-openai test bun run --cwd plugins/plugin-app-control test bun run --cwd plugins/pl… (push) Has been cancelled
Windows CI / windows ([node packages/scripts/run-turbo.mjs run build --filter=@elizaos/core --filter=@elizaos/shared --filter=@elizaos/agent --concurrency=4 node packages/scripts/run-bash-linux-only.mjs scripts/verify-riscv64-buildpaths.sh node packages/scripts/run… (push) Has been cancelled
Windows CI / windows ([node packages/scripts/run-turbo.mjs run typecheck --filter=@elizaos/core --filter=@elizaos/shared --filter=@elizaos/cloud-shared --concurrency=4 bun run --cwd packages/core test bun run --cwd packages/shared test], core-runtime, 75) (push) Has been cancelled
121 lines
3.6 KiB
Plaintext
121 lines
3.6 KiB
Plaintext
---
|
|
title: API Overview
|
|
description: Complete REST API reference for elizaOS Cloud. OpenAI-compatible endpoints for chat, embeddings, and more.
|
|
---
|
|
|
|
# REST API Reference
|
|
|
|
elizaOS Cloud provides a comprehensive REST API for all platform features.
|
|
|
|
<Info>
|
|
Looking for a full, route-by-route explorer? Go to [API Explorer
|
|
→](/cloud/api/overview)
|
|
</Info>
|
|
|
|
## Base URL
|
|
|
|
```
|
|
https://elizacloud.ai/api/v1
|
|
```
|
|
|
|
## Authentication
|
|
|
|
All API requests require authentication via API key or session token:
|
|
|
|
```bash
|
|
curl -X GET "https://elizacloud.ai/api/v1/dashboard" \
|
|
-H "Authorization: Bearer YOUR_API_KEY"
|
|
```
|
|
|
|
<Info>
|
|
Get your API key from [Dashboard → API Keys](https://elizacloud.ai/dashboard/api-keys)
|
|
</Info>
|
|
|
|
### Authentication Methods
|
|
|
|
| Method | Header | Use Case |
|
|
| --------- | ------------------------------ | -------------------- |
|
|
| API Key | `Authorization: Bearer eliza_xxx` | Server-to-server |
|
|
| X-API-Key | `X-API-Key: eliza_xxx` | Alternative header |
|
|
| Session | Cookie-based | Browser applications |
|
|
|
|
## API Categories
|
|
|
|
<CardGroup>
|
|
<CardGroup.Card title="Chat Completions" href="/cloud/api/chat">
|
|
OpenAI-compatible chat API with streaming support
|
|
</CardGroup.Card>
|
|
<CardGroup.Card title="Messages" href="/cloud/api/messages">
|
|
Anthropic-compatible messages API for Claude Code and SDK clients
|
|
</CardGroup.Card>
|
|
<CardGroup.Card title="Embeddings" href="/cloud/api/embeddings">
|
|
Generate vector embeddings for text
|
|
</CardGroup.Card>
|
|
<CardGroup.Card title="Agents" href="/cloud/api/agents">
|
|
Manage AI agents and characters
|
|
</CardGroup.Card>
|
|
<CardGroup.Card title="API Keys" href="/cloud/api/api-keys">
|
|
Create and manage server credentials
|
|
</CardGroup.Card>
|
|
<CardGroup.Card title="Knowledge" href="/cloud/api/documents">
|
|
Upload and query documents
|
|
</CardGroup.Card>
|
|
<CardGroup.Card title="Apps" href="/cloud/api/apps">
|
|
Create and manage applications
|
|
</CardGroup.Card>
|
|
<CardGroup.Card title="Containers" href="/cloud/api/containers">
|
|
Deploy and monitor containers
|
|
</CardGroup.Card>
|
|
<CardGroup.Card title="Credits & Billing" href="/cloud/api/credits">
|
|
Check account credits and usage
|
|
</CardGroup.Card>
|
|
</CardGroup>
|
|
|
|
## Error Handling
|
|
|
|
All errors follow a consistent format:
|
|
|
|
```json
|
|
{
|
|
"error": {
|
|
"code": "INVALID_REQUEST",
|
|
"message": "The request body is invalid",
|
|
"details": "Field 'model' is required"
|
|
}
|
|
}
|
|
```
|
|
|
|
### Error Codes
|
|
|
|
| Code | HTTP Status | Description |
|
|
| ---------------------- | ----------- | --------------------------------- |
|
|
| `UNAUTHORIZED` | 401 | Invalid or missing authentication |
|
|
| `FORBIDDEN` | 403 | Insufficient permissions |
|
|
| `NOT_FOUND` | 404 | Resource not found |
|
|
| `RATE_LIMITED` | 429 | Too many requests |
|
|
| `INSUFFICIENT_CREDITS` | 402 | Not enough credits |
|
|
| `INTERNAL_ERROR` | 500 | Server error |
|
|
|
|
## Rate Limits
|
|
|
|
| Endpoint | Rate Limit |
|
|
| ---------------- | ----------- |
|
|
| Chat completions | 60 req/min |
|
|
| Embeddings | 100 req/min |
|
|
| Image generation | 20 req/min |
|
|
| Video generation | 5 req/min |
|
|
|
|
<Info>
|
|
Rate limits can be increased for enterprise plans. Contact sales for details.
|
|
</Info>
|
|
|
|
## OpenAPI Specification
|
|
|
|
The full OpenAPI specification is available at:
|
|
|
|
```
|
|
https://elizacloud.ai/api/openapi.json
|
|
```
|
|
|
|
You can use this with tools like Swagger UI, Postman, or to generate client SDKs.
|