API Reference¶

The Pipelit platform exposes a RESTful API under the /api/v1/ prefix. All endpoints accept and return JSON.

Base URL¶

http://localhost:8000/api/v1/

Authentication¶

All API endpoints (except /auth/setup-status/ and /auth/setup/) require a Bearer token in the Authorization header.

Authorization: Bearer <api_key>

Obtain a token by calling POST /api/v1/auth/token/ with your username and password. If multi-factor authentication (MFA) is enabled on the account, an additional step via POST /api/v1/auth/mfa/login-verify/ is required.

Requests without a valid token receive a 401 Unauthorized response.

Pagination¶

All list endpoints accept limit and offset query parameters and return a paginated envelope:

Response format:

{
  "items": [ ... ],
  "total": 123
}

• items -- array of resource objects for the current page.
• total -- total count of matching resources (before pagination).

Request Format¶

• Content-Type: application/json
• Request bodies use JSON. Fields marked as optional can be omitted.
• PATCH endpoints accept partial updates -- only include the fields you want to change.

Response Format¶

All successful responses return JSON. Single-resource endpoints return the resource object directly. List endpoints return the paginated envelope described above.

Error Codes¶

Error response body:

{
  "detail": "Human-readable error message"
}

For validation errors (422), the detail field may contain a structured object:

{
  "detail": {
    "validation_errors": [
      "Source type 'trigger_chat' output 'text' is not compatible with target input 'model'"
    ]
  }
}

API Sections¶