Skip to content

Build AI methods with your coding agent, then run them anywhere: as an MCP for chatbots, as a webapp for people, or via API for your software.

5.9 KB
Raw Blame
# ──────────────────────────────────────────────────────────────────────────────
# Required
# ──────────────────────────────────────────────────────────────────────────────

# OpenAI API key — the image enables the `openai` backend, which serves every
# default language-model and image-generation tier of the bundled model deck.
#
# This is the only credential needed *if* you keep the bundled backends. To use
# Anthropic, Azure, Bedrock, OpenRouter, etc. instead, mount your own
# `inference/backends.toml` override enabling them and set their own env vars.
# Search (Linkup) and OCR (Mistral) need that override to enable their backend as
# well as its key. Without OCR, document extraction reads a PDF's text layer only.
# See https://docs.pipelex.com/latest/api-server/configuration/ for the details.

OPENAI_API_KEY=

# ──────────────────────────────────────────────────────────────────────────────
# Authentication (optional — defaults to AUTH_MODE=none)
# ──────────────────────────────────────────────────────────────────────────────

# One of: none | api_key | jwt, spelled exactly. Unset or empty means none;
# any other value refuses to start the server.
# AUTH_MODE=none

# Used when AUTH_MODE=api_key. Clients pass: Authorization: Bearer <API_KEY>
# API_KEY=

# Used when AUTH_MODE=jwt. Tokens must be HS256 and carry a "user_id" claim
# that is a single path-safe segment.
# JWT_SECRET_KEY=

# When AUTH_MODE=none and the API sits behind a trusted reverse proxy that
# performs authentication and forwards the caller's id in the X-User-Id
# header, set this to "true" to honor that header, the only one the server
# reads. DEFAULT IS OFF: if you set this, you MUST ensure your proxy strips
# inbound copies of the header before adding its own — otherwise any
# external client can spoof user identity by sending the header itself.
# With it on, a request arriving without X-User-Id is refused with a 401.
# TRUST_FORWARDED_IDENTITY_HEADERS=false

# ──────────────────────────────────────────────────────────────────────────────
# Uploader (optional — only relevant if you use POST /v1/upload)
# ──────────────────────────────────────────────────────────────────────────────

# Maximum decoded size, in MiB, accepted by the /upload endpoint. Defaults to
# 50. Raise it for larger documents/datasets, lower it to harden the server
# against memory exhaustion. Read once at startup — change requires a restart.
# MAX_UPLOAD_MIB=50

# ──────────────────────────────────────────────────────────────────────────────
# Pipelex environment selector (optional)
# ──────────────────────────────────────────────────────────────────────────────

# Selects which pipelex_{PIPELEX_ENV}.toml override file is layered on top of
# the baseline configuration. Defaults to "dev" when unset. See docs/configuration.md.
# PIPELEX_ENV=dev

# ──────────────────────────────────────────────────────────────────────────────
# Temporal (optional — only needed when [temporal] is_enabled = true in your config)
# ──────────────────────────────────────────────────────────────────────────────

# Pipelex's [temporal] config block can interpolate env vars via ${VAR}
# (e.g. `api_key = "${TEMPORAL_API_KEY}"`). This var has no effect on its own —
# it's only useful if your mounted `.pipelex/` config references it.
# TEMPORAL_API_KEY=

# ──────────────────────────────────────────────────────────────────────────────
# Bundle runner tooling (optional — used by `make bundle-*` / the
# postman-bundle skill, NOT read by the API server itself)
# ──────────────────────────────────────────────────────────────────────────────

# Default callback webhook for the async POST /v1/start endpoint.
# A `start` request is fire-and-forget: it returns a run_id immediately
# and POSTs the finished result to this URL later. The `make bundle-*` targets
# and the postman-bundle skill read this when building a `start` query
# (override per run with CALLBACK_URL=... or --callback-url). Must be a public
# http(s) URL — loopback/private/metadata hosts are rejected by the API's SSRF
# guard. A throwaway https://webhook.site/<id> endpoint is the easy way to watch
# results land.
# CALLBACK_URL=