pipelex/pipelex-api repository overview

⁠Pipelex API Server

The official REST API server for building and executing Pipelex pipelines. Deploy your pipelines as HTTP endpoints and integrate them into any application or workflow.

API Documentation⁠ - Pipelex Core⁠ - Discord⁠

⁠📑 Table of Contents

• Introduction⁠
• Quick Start with Docker⁠
• API Documentation⁠
• Support⁠
• License⁠

⁠Introduction

The Pipelex API Server is a FastAPI-based REST API that allows you to execute Pipelex⁠ pipelines via HTTP requests. Deploy your pipelines as HTTP endpoints and integrate them into any application or workflow.

⁠🚀 Quick Start with Docker

Official Docker image available at: pipelex/pipelex-api⁠

⁠1. Configure Environment

Create a .env file with your API key and LLM provider configuration:

# Required: Your API authentication key. This is the API key that will be required to access the API.
API_KEY=your-api-key-here

# AI inference provider API keys: either using Pipelex Inference API or your own API key(s) (see configuration below)
BLACKBOX_API_KEY=your-blackboxai-api-key

You can get a free API key ($20 of free credits) by joining our Discord community⁠ and requesting it in the appropriate channel.

⁠2. Run with Docker

Option A: Using Docker Compose (Recommended)

See docker-compose.yml⁠ for reference.

docker-compose up

Option B: Using Docker Run

docker run --name pipelex-api -p 8081:8081 \
  -e API_KEY=your-api-key-here \
  -e BLACKBOX_API_KEY=your-blackboxai-api-key-here \
  pipelex/pipelex-api:latest

Option C: Build Locally

docker build -t pipelex-api .
docker run --name pipelex-api -p 8081:8081 \
  -e API_KEY=your-api-key-here \
  -e BLACKBOX_API_KEY=your-blackboxai-api-key-here \
  pipelex-api

⁠3. Verify

curl http://localhost:8081/health

The API is now running at http://localhost:8081

⁠📖 API Documentation

For complete API documentation, including input formats, error handling, best practices, and client library examples:

https://docs.pipelex.com/pages/api/⁠

⁠💬 Support

• API Documentation: https://docs.pipelex.com/pages/api/⁠
• Pipelex Documentation: https://docs.pipelex.com/⁠
• Discord Community: https://go.pipelex.com/discord⁠
• Main Repository: https://github.com/Pipelex/pipelex⁠

⁠📝 License

This project is licensed under the MIT license⁠. Runtime dependencies are distributed under their own licenses via PyPI.

"Pipelex" is a trademark of Evotis S.A.S.

© 2025 Evotis S.A.S.