Reference
API Reference
REST API endpoints for programmatic access to your Lobstack agent. Send messages, manage sessions, configure skills, and more.
📝
Authentication
All API requests are authenticated via secure session cookies. The dashboard handles this automatically. For programmatic access, authenticate via the Supabase Auth API first.
Agent Status#
Get the current status of your agent, including server details, usage metrics, and optional related data.
Response Fields#
| Field | Type | Description |
|---|---|---|
| agent.id | string | Unique agent instance ID |
| agent.status | string | running, provisioning, or error |
| agent.server_ip | string | VM IP address |
| agent.server_tier | string | starter, standard, performance, enterprise |
| agent.server_region | string | us-east, us-west, eu-central, eu-north, ap-south |
| agent.ai_model | string | Current AI model identifier |
| agent.messages_used | number | Messages used this billing period |
| agent.messages_limit | number | Monthly message limit for current plan |
| agent.plan_tier | string | Subscription plan tier |
| messages | array | Recent messages (when include=messages) |
| skills | array | Enabled skills (when include=skills) |
Chat#
Send a message to your agent and receive a response. The agent may execute tools during processing.
| Parameter | Type | Required | Description |
|---|---|---|---|
| message | string | Yes | The user message to send |
| session_id | string | No | Session ID for conversation isolation |
| images | array | No | Base64 image data for multimodal analysis |
Sessions#
List Sessions#
Create Session#
Update Session#
Update session metadata — title, category, status, icon, or pinned state. At least one field is required.
| Parameter | Type | Description |
|---|---|---|
| sessionId | string | Session ID to update (required) |
| title | string | New session title (max 100 chars) |
| category | string | general, task, research, support, automation, creative, or debug |
| status | string | active, completed, paused, or archived |
| icon | string | Custom icon for the session |
| pinned | boolean | Pin session for quick access |
Delete Session#
Skills#
Get Enabled Skills#
Enable/Disable Skill#
Configure Skill Credentials#
Memory#
Token Budget#
Get token budget status or request a model routing recommendation based on message complexity.
Chat Automation#
Create workflows from natural language commands. Used by slash commands like /automate, /schedule, /trigger, and /remind.
| Parameter | Type | Description |
|---|---|---|
| command | string | automate, schedule, trigger, remind, or status |
| text | string | Natural language description of the automation |
Update Agent Settings#
Change AI model, messenger, server tier, or region. Triggers a full VM rebuild.
| Parameter | Type | Description |
|---|---|---|
| aiModel | string | AI model to switch to |
| messengerType | string | Messenger channel (web, telegram, discord, slack, whatsapp) |
| serverTier | string | Server tier (starter, standard, performance, enterprise) |
| serverRegion | string | Server region (us-east, us-west, eu-central, eu-north, ap-south) |
| aiApiKey | string | Your own AI provider API key (optional) |