Developers/API Reference

API Reference

The FlockSoft REST API gives you programmatic access to agents, tasks, webhooks, and account management. All responses are JSON.

Base URL
api.flocksoft.com/v1
Auth
Bearer token
Version
v1.0 — Stable
Authentication

Bearer token auth

All API requests must include an Authorization header with a valid API key. Keys are generated in your account settings and can be scoped to specific permissions.

API keys are prefixed with fs_live_ for production and fs_test_ for sandbox.

Keys are shown only once at creation. Store them securely — they cannot be retrieved after the initial display.

Example Request
curl https://api.flocksoft.com/v1/agents \
  -H "Authorization: Bearer fs_live_••••••••" \
  -H "Content-Type: application/json"
Response
{
  "data": [...],
  "meta": {
    "total": 12,
    "page": 1
  }
}
Endpoints

All available
endpoints.

Agents
GET/v1/agentsList all agents in your account
POST/v1/agentsCreate a new agent
GET/v1/agents/{id}Retrieve a specific agent
PATCH/v1/agents/{id}Update agent configuration
DELETE/v1/agents/{id}Archive an agent
POST/v1/agents/{id}/runTrigger an agent execution
Tasks
GET/v1/tasksList all tasks across agents
GET/v1/tasks/{id}Retrieve a specific task
GET/v1/tasks/{id}/logsRetrieve execution logs for a task
POST/v1/tasks/{id}/cancelCancel a running task
Webhooks
GET/v1/webhooksList all configured webhooks
POST/v1/webhooksRegister a new webhook endpoint
DELETE/v1/webhooks/{id}Remove a webhook
POST/v1/webhooks/{id}/testSend a test event to a webhook
Account
GET/v1/accountRetrieve account details and usage
GET/v1/account/api-keysList API keys
POST/v1/account/api-keysGenerate a new API key
DELETE/v1/account/api-keys/{id}Revoke an API key
Rate Limits

Limits by plan

Starter
Requests
1,000 / hour
Agents
5 agents
Tasks
10,000 / month
Growth
Requests
10,000 / hour
Agents
25 agents
Tasks
250,000 / month
Enterprise
Requests
Custom
Agents
Unlimited
Tasks
Unlimited
View SDKs →Status PageAPI Support