Pipelex API

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 keys:

# Required: API key to authenticate requests to this API server
API_KEY=your-api-key-here

# Required: Pipelex Gateway API key to access all LLMs
PIPELEX_GATEWAY_API_KEY=your-pipelex-gateway-api-key

You can get a free Pipelex Gateway API key ($20 of free credits) here https://app.pipelex.com

For complete API key configuration, see the API Key Configuration section in the main Pipelex repository.

2. Run with Docker

Option A: Using Docker Run (Recommended)

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

Option B: Using Docker Compose

See docker-compose.yml for reference.

docker-compose up

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 PIPELEX_GATEWAY_API_KEY=your-pipelex-gateway-api-key \
  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.