Skip to main content

API Reference

430+ endpoint methods across 270+ REST API routes for full programmatic access to the Alumia platform.

Base URL: https://alumia.com/api/v1

Authentication: All API requests require a Bearer token or API key in the Authorization header. Get your API key from Settings → API Keys in the dashboard.

Authentication
/api/v1/auth
POST/loginSign in with email and password
POST/registerCreate a new account
POST/refreshRefresh access token
POST/logoutSign out and invalidate tokens
GET/meGet current user profile
Agents
/api/v1/agents
GET/List all agents
POST/Create a new agent
GET/:idGet agent by ID
PATCH/:idUpdate an agent
DELETE/:idDelete an agent
Chat & Sessions
/api/v1
POST/chatSend a message
GET/chat/:sessionId/streamStream chat responses (SSE)
GET/sessionsList all sessions
POST/sessionsCreate a new session
GET/sessions/:idGet session details
DELETE/sessions/:idDelete a session
Connectors
/api/v1/connectors
GET/List available connectors
GET/:slugGet connector details
GET/credentialsList credentials
POST/credentialsAdd a credential
GET/oauth/:providerStart OAuth flow
Tasks
/api/v1/tasks
GET/List tasks (filter: status, priority, label, overdue, dueBefore, dueAfter, hasAssignee, search, sortBy, sortDir)
POST/Create a task
GET/:idGet task by ID
PATCH/:idUpdate a task (status, priority, dueDate, blockedBy, blocks, label, assignee)
DELETE/:idDelete a task
GET/:id/commentsList task comments
POST/:id/commentsAdd a comment
DELETE/:id/comments/:commentIdDelete a comment
GET/:id/attachmentsList task attachments
POST/:id/attachmentsAttach a file to a task
DELETE/:id/attachments/:fileIdRemove attachment from task
PATCH/bulkBulk update tasks
DELETE/bulkBulk delete tasks
Schedules
/api/v1/schedules
GET/List schedules (filter: status, agentId, scheduleKind, search, sortBy, sortDir; agentId=none for unassigned)
POST/Create a schedule (interval/random/cron/once types)
GET/:idGet schedule by ID
PATCH/:idUpdate a schedule
DELETE/:idDelete a schedule
POST/:id/runManually trigger a schedule now
GET/:id/executionsGet execution history
POST/ai-parseParse schedule from natural language description
Activities
/api/v1/activities
GET/List activities (filter by type, project, status)
POST/Create an activity
GET/:idGet activity by ID
PATCH/:idUpdate activity status
DELETE/:idDelete an activity
POST/:id/resolveResolve an agent question
POST/mark-readMark activities as read
GET/unread-countGet unread activity count
GET/streamReal-time activity stream (SSE)
Webhooks
/api/v1/webhooks
GET/List webhooks
POST/Create a webhook
GET/:id/eventsList webhook events
GET/:id/deliveriesList delivery attempts
Billing
/api/v1/billing
GET/plansList subscription plans
GET/subscriptionGet current subscription
POST/checkoutCreate checkout session
GET/creditsGet credit balance
GET/usageGet usage statistics

This is a summary of the most common endpoints. For the full API specification, sign in and visit the in-app documentation.