Pipelines API
Deploy and manage multi-engine data pipeline templates. Pipelines combine multiple database services into pre-configured topologies for AI/ML and analytics use cases.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /pipelines/templates | List available templates |
GET | /pipelines/templates/{id} | Get a template |
POST | /pipelines | Deploy a pipeline |
GET | /pipelines | List deployed pipelines |
GET | /pipelines/{id} | Get pipeline details |
DELETE | /pipelines/{id} | Delete pipeline and all services |
Available Templates
| Template | ID | Services |
|---|---|---|
| RAG Pipeline | rag-pipeline | Kafka + PostgreSQL (pgvector) + Valkey |
| Recommendation Engine | recommendation-engine | Kafka + PostgreSQL + Valkey |
| Event Analytics | event-analytics | Kafka + OpenSearch + PostgreSQL |
Deploy a Pipeline
curl -u $USER:$PASS -X POST https://api.foundrydb.com/pipelines \
-H "Content-Type: application/json" \
-d '{
"template_id": "rag-pipeline",
"name": "my-rag",
"zone": "se-sto1"
}'
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | Template identifier |
name | string | Yes | Pipeline name (services get suffixes) |
zone | string | Yes | Deployment zone (e.g., se-sto1) |
plan_name | string | No | Override default plan for all services |
organization_id | string | No | Organization to own the pipeline |
Response (201)
{
"id": "a1b2c3d4-...",
"template_id": "rag-pipeline",
"name": "my-rag",
"zone": "se-sto1",
"status": "deploying"
}
Get Pipeline Details
curl -u $USER:$PASS https://api.foundrydb.com/pipelines/$PIPELINE_ID
Returns full details including services, topology members, and connection parameters:
{
"status": "running",
"services": [...],
"members": [...],
"connections": [
{
"role": "kafka-ingestion",
"connections": {
"bootstrap_servers": "my-rag-kafka.abc123.db.foundrydb.com:9093",
"security_protocol": "SASL_PLAINTEXT"
}
},
{
"role": "vector-store",
"connections": {
"connection_uri": "postgresql://app_user@my-rag-pgvector.abc123.db.foundrydb.com:5432/defaultdb?sslmode=require"
}
}
]
}
Pipeline Statuses
| Status | Description |
|---|---|
deploying | Services are being provisioned |
running | All services are healthy |
degraded | Some services are unhealthy |
deleting | Pipeline is being torn down |