Platform — API

Redbird in your stack — through standard REST

Redbird's REST API gives your engineering team standard HTTP access to the full platform — trigger workflow runs, manage datasets, and build Redbird's AI automation capabilities into any application, pipeline, or internal system. Any language. Any stack.

Read the docs Talk to an engineer →

Works with Python JavaScript Java Go curl Any HTTP client

              
              
              
              HTTP Request
              REST
            

POST /api/workflows/{workflow_id}/run HTTP/1.1
Host:           app.redbird.io
Authorization:  Bearer <session_token>
Content-Type:   application/json

{
  "project_id": "proj_4a8f2c1d",
  "inputs": {
    "dataset_id": "ds_9b3e7f12"
  }
}
            

200 OK Response

{
  "run_id":     "run_7c4a1e9f",
  "status":     "queued",
  "workflow_id": "wf_2d8b5c3a",
  "created_at": "2025-05-02T14:23:01Z"
}

How It Works

Standard HTTP in. Redbird's AI capabilities out.

The Redbird REST API is built on standard HTTP — GET and POST requests, JSON responses, credential-based authentication. There's no proprietary client, no framework to install, no lock-in. If your system can make an HTTP request, it can integrate with Redbird.

This means Redbird's AI agents, automation workflows, and data outputs become modular components in any architecture your engineering team already runs — without requiring teams to adopt a new development paradigm or rebuild existing pipelines around Redbird.

Standard REST

HTTP GET and POST, JSON in and out. No proprietary client or SDK required to get started.

Any language or framework

Python, JavaScript, Java, Go, Ruby, or a curl script — the API works identically everywhere.

Authenticate with your Redbird credentials

API access uses your existing Redbird user and project permissions. No separate credential system.

Trigger workflows programmatically

Run any Redbird automation workflow on demand from your own orchestration layer, scheduler, or application backend.

Access data assets

Read, explore, augment, and slice Redbird dataset outputs from external systems — without manual exports or UI access.

Get your credentials

Your Redbird username, password, and project ID — available from your existing Redbird account

POST /api/token/

Receive a session token

Authenticate once to receive a bearer token — include it on all subsequent requests

Authorization: Bearer <token>

Reference your resources

Identify the project, workflow, or dataset you want to work with by ID

GET /api/workflows/

Make HTTP requests

POST to trigger a run, GET to check status, GET to read data outputs

POST /api/workflows/{id}/run

Handle JSON responses

All responses are structured JSON with standard HTTP status codes and error detail

200 OK · 400 · 401 · 404

Integration

Plug Redbird into the systems your team already runs

The REST API is designed for teams that need Redbird to fit inside a larger enterprise architecture — not replace it. Trigger Redbird workflow runs from your own orchestration layer, pull dataset outputs into downstream systems, or build Redbird-powered automation into internal tools — without requiring users to access Redbird directly.

Trigger workflow runs from any external system or orchestration layer — on demand or as part of a pipeline
Pull data outputs into downstream applications, data warehouses, or internal reporting tools
Build Redbird-powered features into internal portals or custom applications without surface-level Redbird UI access
Chain Redbird workflows with external processes — Redbird executes its step, returns the result, your system takes it from there

            
            
            
            pipeline_trigger.py
            Python · requests
          

# Authenticate
resp = requests.post("https://app.redbird.io/api/token/", json={
    "username": os.environ["REDBIRD_USER"],
    "password": os.environ["REDBIRD_PASS"],
})
token = resp.json()["access"]
headers = {"Authorization": f"Bearer {token}"}

# Trigger a workflow run
run = requests.post(
    f"https://app.redbird.io/api/workflows/{WORKFLOW_ID}/run",
    headers=headers,
    json={"project_id": PROJECT_ID},
)
run_id = run.json()["run_id"]

# Poll until complete
while True:
    status = requests.get(
        f"https://app.redbird.io/api/workflows/{WORKFLOW_ID}/runs/{run_id}",
        headers=headers,
    ).json()["status"]
    if status == "complete": break
    time.sleep(10)
          

API Endpoints

Method	Endpoint	What it does
POST	/api/token/	Authenticate and receive a session token
GET	/api/workflows/	List all workflows in a project
POST	/api/workflows/{id}/run	Trigger a workflow run
GET	/api/workflows/{id}/runs/{run_id}	Check run status and retrieve outputs
GET	/api/datasets/	List datasets available in a project
GET	/api/datasets/{id}/slice	Read and filter a dataset output

What You Can Do

Workflows, data assets — all reachable via API

The Redbird REST API covers the core operational surfaces of the platform. Trigger and monitor workflow runs, explore and augment data outputs — all from standard HTTP calls your team can integrate into any existing system.

Trigger and monitor workflows — Run any Redbird workflow on demand and retrieve run status and outputs programmatically
Slice datasets — Read and filter Redbird dataset outputs for use in downstream applications or reporting layers
Standard authentication — Credential-based auth tied to your existing Redbird user and project access model — consistent with the platform's permission structure
Standard HTTP error codes — Error responses follow standard HTTP status codes with structured JSON error detail — no custom error handling required

Getting Started

Up and running in minutes

Authentication requires your Redbird username, password, and project details — all available from your existing Redbird account. The full tutorial walks through each major API operation with working examples. The sandbox script covers all key endpoints in one runnable file — the fastest way to validate the integration before building.

Works with any HTTP client — curl, Postman, Requests, Axios, HttpClient, and more
Error responses follow standard HTTP status codes with structured JSON error detail
No proprietary client installation or framework lock-in — if it speaks HTTP, it works

            
            
            
            quickstart.sh
            curl
          

# Step 1: Authenticate
curl -s -X POST https://app.redbird.io/api/token/ \
  -H "Content-Type: application/json" \
  -d '{"username":"you@co.com","password":"••••"}'

# Step 2: Trigger a workflow run
curl -s -X POST https://app.redbird.io/api/workflows/wf_2d8b5c3a/run \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"proj_4a8f2c1d"}'

# Step 3: Check run status
curl -s -X GET https://app.redbird.io/api/workflows/wf_2d8b5c3a/runs/run_7c4a1e9f \
  -H "Authorization: Bearer $TOKEN"
          

200 OK Run status response

{
  "run_id":      "run_7c4a1e9f",
  "status":      complete,
  "outputs": [
    {
      "dataset_id": "ds_3f7c2b8a",
      "rows":       14302,
      "url":        "/api/datasets/ds_3f7c2b8a/slice"
    }
  ]
}