Developers

Developer Documentation

Everything you need to build on FlockSoft. Our API is RESTful, our SDKs are typed, and our documentation is maintained by the same team that ships the platform.

API Version
v1.0
Uptime
99.97%
Latency p99
<120ms
Resources

Everything you
need to integrate.

01

API Reference

Complete REST API documentation. Authentication, endpoints, request schemas, response formats, and error codes — everything you need to integrate.

REST · JSON · v1.0View API Docs →
02

SDKs & Libraries

Official client libraries for TypeScript, Python, and Go. Install via npm or pip, then start building in minutes with typed interfaces and built-in retries.

TypeScript · Python · GoView SDKs →
03

Webhooks

Subscribe to real-time events from your FlockSoft agents. Agent state changes, task completions, errors, and audit events are all available via webhook.

Real-time eventsWebhook Docs →
04Coming Soon

Sandbox

A full replica of the production environment for testing and development. Isolated credentials, mock data, and no production side effects.

Isolated environmentComing Soon
05

GitHub

Open-source SDKs, example projects, and integration templates. Star, fork, or contribute — all public development happens in the open.

github.com/flocksoftView on GitHub →
06Operational

Status Page

Real-time and historical uptime data for all FlockSoft services. Subscribe to status notifications for any component.

All systems operationalView Status →
Quick Start

Up and running
in four steps.

01

Get your API key

Sign in to your FlockSoft account and navigate to Settings → API Keys to generate your first credential.

02

Install the SDK

Run npm install @flocksoft/sdk or pip install flocksoft to add the official client library to your project.

npm install @flocksoft/sdk
03

Make your first call

Initialize the client and call your first agent endpoint. Production-ready in under five minutes.

const client = new FlockSoft({ apiKey: process.env.FLOCKSOFT_API_KEY })
04

Read the reference

Explore the full API reference for authentication, rate limits, pagination, and all available endpoints.

Need help integrating?

Our developer support team responds within one business day. For enterprise integration support, book a technical call with our team.

View API Reference →Contact Support