Skip to content

API-Based Execution & Token Management 🚀

flowyml provides a robust REST API for executing pipelines, managing tokens, and interacting with the system programmatically. This allows you to integrate flowyml into your existing infrastructure, such as CI/CD pipelines or custom dashboards.

🔑 Token Management

Secure access to the flowyml API is managed via API tokens.

Creating Tokens

You can generate tokens via the UI or CLI.

Using CLI: 

1
2
3
4
5
6
7
8
# Generate a new token
flowyml token create --name "ci-cd-token" --role "admin"

# List tokens
flowyml token list

# Revoke a token
flowyml token revoke --token-id <token_id>

Using UI: 1. Navigate to Settings > API Tokens. 2. Click Generate New Token. 3. Copy the token immediately; it won't be shown again.

Using Tokens

Include the token in the Authorization header of your HTTP requests:

1
Authorization: Bearer <your_token>

🚀 API-Based Pipeline Execution

You can trigger pipelines remotely using the REST API.

Trigger a Run

Endpoint: POST /api/v1/runs

Request Body: 

1
2
3
4
5
6
7
8
{
  "pipeline_name": "training_pipeline",
  "project": "default",
  "parameters": {
    "learning_rate": 0.01,
    "epochs": 20
  }
}

Example (curl): 

1
2
3
4
5
6
7
curl -X POST http://localhost:8080/api/v1/runs \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline_name": "training_pipeline",
    "parameters": {"epochs": 50}
  }'

Check Run Status

Endpoint: GET /api/v1/runs/{run_id}

Response: 

1
2
3
4
5
6
{
  "run_id": "run_12345",
  "status": "running",
  "created_at": "2023-10-27T10:00:00Z",
  "pipeline_name": "training_pipeline"
}

List Runs

Endpoint: GET /api/v1/runs

Query Parameters: - pipeline_name: Filter by pipeline. - status: Filter by status (e.g., success, failed). - limit: Number of results to return.

📚 API Reference

For a complete list of endpoints, visit the interactive API documentation (Swagger UI) at:

http://localhost:8080/docs