API Reference

Bizon Platform provides a comprehensive REST API for all platform operations.

Base URL

http://localhost:8000/api

Authentication

All endpoints (except auth routes) require authentication:

# JWT Token
Authorization: Bearer eyJ...

# OR API Key
X-API-Key: biz_live_...

Response Format

All responses are JSON. Successful responses return the requested data. Errors return:

{
  "detail": "Error message"
}

Common Status Codes

Code	Description
200	Success
201	Created
204	No Content (successful delete)
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
409	Conflict
500	Internal Server Error

API Sections

Auth

Authentication endpoints - Login, register, OAuth, tokens.

Pipelines

Pipeline endpoints - Create, manage, and run pipelines.

Connectors

Connector endpoints - Discover and save connectors.

Custom Sources

Custom source endpoints - Build custom connectors.

Users

User endpoints - Manage members and invitations.

Domains

Domain endpoints - Organize by team/function.

API Keys

API key endpoints - Programmatic access.

Quick Reference

Pipelines

POST   /api/pipelines              Create pipeline
GET    /api/pipelines              List pipelines
GET    /api/pipelines/{id}         Get pipeline
PUT    /api/pipelines/{id}         Update pipeline
DELETE /api/pipelines/{id}         Delete pipeline
POST   /api/pipelines/{id}/run     Trigger run

Runs

GET    /api/pipelines/{id}/runs         List runs
GET    /api/pipelines/runs/{run_id}     Get run status
GET    /api/pipelines/runs/{run_id}/logs     Get logs
POST   /api/pipelines/runs/{run_id}/cancel   Cancel run

Authentication

POST   /api/auth/register      Register + create org
POST   /api/auth/login         Login
POST   /api/auth/refresh       Refresh tokens
GET    /api/auth/me            Get current user

Users & Invitations

GET    /api/users              List members
POST   /api/users/invite       Invite user
POST   /api/users/invitations/accept   Accept invite