Documentation v1.0

B.O.O.B.I.E. API Reference

Welcome to the official boobie.ai developer documentation. The B.O.O.B.I.E.™ platform gives you programmatic access to AI automation, intelligent workflows, data pipelines, and agent orchestration — all built for enterprise and creator ecosystems.

99.9%
Uptime SLA
Global
Edge Network
SOC 2
Compliant
24/7
Developer Support
ℹ️

All API requests must be authenticated using your API key. Book a strategy call to receive your API credentials and access the sandbox environment.

Quickstart

Get your first automation running in under 5 minutes. Install the SDK, authenticate, and trigger your first workflow.

Step 1 — Install the SDK

bash
# Python
pip install boobie-ai

# JavaScript / Node.js
npm install @boobie-ai/sdk

# Go
go get github.com/boobie-ai/sdk-go

Step 2 — Initialize the Client

python
from boobie_ai import BooobieClient

client = BooobieClient(api_key="YOUR_API_KEY")

# Test your connection
status = client.ping()
print(status)  # {"status": "ok", "environment": "production"}

Step 3 — Trigger Your First Automation

python
workflow = client.workflows.trigger(
    workflow_id="wf_your_workflow_id",
    inputs={
        "data_source": "crm",
        "action": "sync_contacts",
        "notify": True
    }
)

print(workflow.status)   # "running"
print(workflow.run_id)   # "run_abc123xyz"

Authentication

All requests to the B.O.O.B.I.E.™ API require a valid API key passed in the request header. Never expose your API key in client-side code.

http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
⚠️

Keep your API keys secure. Rotate them immediately if compromised. All keys are scoped to an environment (sandbox vs. production) and cannot be used across environments.

API Key Scopes

  • read — Read-only access to resources and run history
  • write — Create and update workflows, automations, and agents
  • execute — Trigger workflow runs and agent tasks
  • admin — Full access including billing and team management

Environments

boobie.ai provides two fully isolated environments. Use sandbox for development and testing at no cost. Switch to production for live deployments.

https://sandbox.api.boobie.ai/v1
Sandbox — Free, unlimited testing. No real data processed.
https://api.boobie.ai/v1
Production — Live environment. Billed per usage tier.

Automation API

The Automation API lets you programmatically build, trigger, and manage AI-powered workflow automations across any connected system.

GET
/v1/automations
List all automations in your workspace
POST
/v1/automations
Create a new automation
GET
/v1/automations/{id}
Retrieve a specific automation by ID
POST
/v1/automations/{id}/trigger
Manually trigger an automation run
DELETE
/v1/automations/{id}
Delete an automation permanently
python — Create Automation
automation = client.automations.create(
    name="Daily CRM Sync",
    trigger={"type": "schedule", "cron": "0 9 * * *"},
    steps=[
        {"action": "fetch_data", "source": "salesforce"},
        {"action": "transform", "map": "contact_schema"},
        {"action": "push", "destination": "hubspot"}
    ]
)
print(automation.id)  # "auto_xyz789"

Intelligence API

Query the B.O.O.B.I.E.™ intelligence layer for real-time analytics, predictive insights, and data pipeline results.

POST
/v1/intelligence/query
Run a natural-language or structured query against your connected data sources
GET
/v1/intelligence/insights
Retrieve AI-generated insights for your workspace
POST
/v1/intelligence/predict
Run a predictive model against specified data
python — Intelligence Query
result = client.intelligence.query(
    question="What are my top 10 customers by revenue this quarter?",
    data_source="warehouse",
    format="table"
)
print(result.answer)
print(result.data)   # Structured table response

Workflow API

The Workflow API orchestrates complex multi-step processes across teams, tools, and systems with built-in error handling, retries, and audit logging.

GET
/v1/workflows
List all workflows
POST
/v1/workflows
Create a new workflow definition
POST
/v1/workflows/{id}/runs
Start a new workflow run
GET
/v1/workflows/{id}/runs/{run_id}
Get the status and output of a specific run

Agent API

Deploy, configure, and communicate with B.O.O.B.I.E.™ AI agents — autonomous workers that learn, adapt, and handle tasks on your behalf.

POST
/v1/agents
Instantiate a new AI agent with a defined role and capabilities
POST
/v1/agents/{id}/tasks
Assign a task to a running agent
GET
/v1/agents/{id}/status
Get current agent status and task queue

SDKs & Libraries

Official SDKs are available for the most popular languages and frameworks. All SDKs are open source, regularly maintained, and fully typed.

🐍
Python SDK
pip install boobie-ai
🟨
JavaScript / Node.js
npm install @boobie-ai/sdk
🔷
TypeScript
npm install @boobie-ai/sdk
Java
maven: com.boobie-ai:sdk
🔵
Go
go get boobie-ai/sdk-go
🔴
.NET / C#
dotnet add BooobieAI

Webhooks

Subscribe to real-time events from the B.O.O.B.I.E.™ platform. Webhooks are delivered as HTTP POST requests to your endpoint with a signed payload.

Available Events

  • workflow.completed — A workflow run finished successfully
  • workflow.failed — A workflow run encountered an error
  • agent.task_completed — An agent finished an assigned task
  • automation.triggered — An automation was triggered
  • alert.fired — An intelligence alert threshold was crossed
python — Webhook Verification
import hmac, hashlib

def verify_webhook(payload, signature, secret):
    expected = hmac.new(
        secret.encode(), payload, hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(f"sha256={expected}", signature)

Rate Limits

Rate limits are applied per API key, per minute. Exceeding the limit returns a 429 Too Many Requests response.

Plan Requests/min Concurrent Agents Workflow Runs/day
Sandbox 60 5 100
Starter 1,000 25 5,000
Professional 10,000 100 50,000
Enterprise Unlimited Unlimited Unlimited

Error Codes

All API errors return a JSON object with a code, message, and optional details field.

HTTP Status Code Description
400bad_requestInvalid request body or parameters
401unauthorizedInvalid or missing API key
403forbiddenAPI key lacks required scope
404not_foundResource not found
429rate_limitedToo many requests — slow down
500internal_errorServer error — contact support

Changelog

v1.0.0 — June 2026

  • Initial release of the B.O.O.B.I.E.™ API platform
  • Automation API, Intelligence API, Workflow API, and Agent API launched
  • SDKs available for Python, JavaScript, TypeScript, Java, Go, and .NET
  • Sandbox environment with full feature parity to production
  • Webhooks for all major platform events
  • SOC 2 Type II compliance achieved

Ready to Build with B.O.O.B.I.E.™?

Book a strategy call with our team to get your API access, discuss your integration, and start building today.

Book Your Strategy Call →