API Documentation

curl "https://pingpulsehq.com/shk/swf123?stage=1&key=YOUR_KEY"

{
  "status": "success",
  "workflow_id": "swf123",
  "instance_id": "sabc456",
  "stage_order": 1,
  "workflow_status": "running"
}

{
  "1": { "status": "healthy", "stage_name": "Ingest" },
  "2.1": { "status": "healthy", "stage_name": "Train GPU A" },
  "2.2": { "status": "pending", "stage_name": "Train GPU B" },
  "3": { "status": "pending" }
}

{
  "running_instance": {
    "id": "d8x9y0z1",
    "status": "running",
    "started_at": "2025-01-15T10:30:00Z",
    "agent_code": "orchestrator",
    "stage_statuses": {
      "1": { "status": "healthy", "stage_name": "Init", "agent_code": "gpt-4" },
      "2": { "status": "healthy", "stage_name": "Process", "agent_code": "worker" }
    }
  },
  "recent_instances": [
    {
      "id": "d7w8x9y0",
      "status": "completed",
      "started_at": "2025-01-15T09:00:00Z",
      "completed_at": "2025-01-15T09:05:30Z",
      "agent_code": "orchestrator",
      "stage_statuses": { ... }
    },
    {
      "id": "d6v7w8x9",
      "status": "failed",
      "started_at": "2025-01-15T08:00:00Z",
      "failure_reason": "Stage 3 timeout",
      "stage_statuses": { ... }
    }
  ]
}

# Get instance history for debugging or retry logic

import requests

response = requests.get(
    "https://pingpulsehq.com/api/workflows/my_pipeline/instances",
    cookies={"access_token": "YOUR_JWT_TOKEN"}  # Or use session auth
)
data = response.json()

# Check if there's a running instance
if data["running_instance"]:
    print(f"Active instance: {data['running_instance']['id']}")

# Analyze recent failures
for inst in data["recent_instances"]:
    if inst["status"] == "failed":
        print(f"Failed: {inst['id']} - {inst.get('failure_reason', 'Unknown')}")
        # Inspect stage_statuses to find where it failed
        for stage_key, stage_info in inst["stage_statuses"].items():
            if stage_info["status"] != "healthy":
                print(f"  Stage {stage_key}: {stage_info['status']}")

curl "https://pingpulsehq.com/phk/ph123/start?key=YOUR_KEY"

curl -X POST "https://pingpulsehq.com/phk/ph123/start" \
  -H "Content-Type: application/json" \
  -d '{"key":"YOUR_KEY","agent":"ci-server","metadata":{"job":"nightly_backup"}}'

curl "https://pingpulsehq.com/phk/ph123/finish?key=YOUR_KEY"

curl -X POST "https://pingpulsehq.com/phk/ph123/finish" \
  -H "Content-Type: application/json" \
  -d '{"key":"YOUR_KEY","agent":"ci-server","metadata":{"status":"success","duration_ms":45000}}'

curl "https://pingpulsehq.com/hbk/cron_backup?key=YOUR_KEY"

curl -X POST "https://pingpulsehq.com/hbk/cron_backup" \
  -H "Content-Type: application/json" \
  -d '{"key":"YOUR_KEY","status":"ok","rows_processed":1500}'

{
  "approval_id": "apr_8k2m4n6p",
  "status": "pending",
  "result": null,
  "expires_at": "2024-01-15T14:05:00Z"
}

{
  "approval_id": "apr_8k2m4n6p",
  "status": "approved",
  "result": 1,
  "notes": "Looks good, proceed!",
  "decided_by": "[email protected]"
}

{
  "instance_id": "d12345678",
  "workflow_id": "dwf_abc123",
  "status": "completed",
  "total_steps": 5,
  "timeline": [
    {
      "step": 0,
      "stage_path": "1",
      "status": "success",
      "executed_at": "2024-01-15T10:00:00Z",
      "response_time_ms": 150,
      "agent_code": "claude-1",
      "model_id": "claude-3-opus",
      "input_tokens": 1500,
      "output_tokens": 500,
      "cost_usd": 0.045,
      "cumulative_cost_usd": 0.045,
      "context_size_bytes": 4096,
      "handoff_reason": "task_complete",
      "payload": {"task": "analyze data"}
    }
  ]
}

{
  "forked_instance_id": "d87654321",
  "session_id": "uuid-here",
  "fork_from_stage": "2",
  "stages_copied": 2
}

{
  "session_id": "uuid-here",
  "comparison": {
    "instance_a": {"id": "d12345678", "aggregates": {...}},
    "instance_b": {"id": "d87654321", "aggregates": {...}},
    "divergence_step": 3,
    "differences": {
      "cost_diff_usd": 0.025,
      "token_diff": 500,
      "time_diff_ms": 1200
    }
  }
}

{
  "new_instance_id": "d98765432",
  "session_id": "uuid-here",
  "message": "Instance created and ready for re-execution"
}

{
  "total_cost_usd": 45.23,
  "today_cost_usd": 8.50,
  "average_cost_per_instance_usd": 0.45,
  "instance_count": 100,
  "most_expensive_instance": {
    "id": "d12345678",
    "cost_usd": 2.30
  },
  "period_days": 7
}

{
  "instance_id": "d12345678",
  "total_cost_usd": 0.125,
  "breakdown": [
    {
      "stage_path": "1",
      "model_id": "claude-3-opus",
      "input_tokens": 1500,
      "output_tokens": 500,
      "cost_usd": 0.045,
      "executed_at": "2024-01-15T10:00:00Z"
    }
  ]
}

{
  "alerts": [
    {
      "id": 1,
      "alert_type": "budget_exceeded",
      "instance_id": "d12345678",
      "current_cost_usd": 105.50,
      "threshold_usd": 100.0,
      "action_taken": "terminate",
      "message": "Instance cost $105.50 exceeds budget limit $100.00",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

{
  "message": "Instance resumed",
  "instance_id": "d12345678",
  "status": "running"
}

import requests

PINGPULSE_KEY = "YOUR_KEY"
BASE_URL = "https://pingpulsehq.com"

def ping_stage(workflow_id, stage, **metadata):
    """Ping a static workflow stage."""
    url = f"{BASE_URL}/shk/{workflow_id}"
    params = {"stage": stage, "key": PINGPULSE_KEY}
    return requests.get(url, params=params).json()

def ping_dynamic(workflow_id, stage_path, start=False, **kwargs):
    """Ping a dynamic workflow stage."""
    url = f"{BASE_URL}/dhk/{workflow_id}"
    params = {"stagePath": stage_path, "key": PINGPULSE_KEY}
    if start:
        params["start"] = "yes"
    if kwargs.get("stagename"):
        params["stagename"] = kwargs["stagename"]
    return requests.get(url, params=params).json()

# Usage
ping_stage("swf123", 1)
ping_dynamic("ml_pipeline", "1", start=True)
ping_dynamic("ml_pipeline", "2.1", stagename="Training")

const axios = require('axios');

const PINGPULSE_KEY = 'YOUR_KEY';
const BASE_URL = 'https://pingpulsehq.com';

async function pingStage(workflowId, stage) {
  const url = `${BASE_URL}/shk/${workflowId}`;
  return axios.get(url, { params: { stage, key: PINGPULSE_KEY } });
}

async function pingDynamic(workflowId, stagePath, options = {}) {
  const url = `${BASE_URL}/dhk/${workflowId}`;
  const params = { stagePath, key: PINGPULSE_KEY };
  if (options.start) params.start = 'yes';
  if (options.stagename) params.stagename = options.stagename;
  return axios.get(url, { params });
}

// Usage
await pingStage('swf123', 1);
await pingDynamic('ml_pipeline', '1', { start: true });

{
  "status": "success",
  "duration": 12.345,
  "airflow": {
    "dag_id": "etl_pipeline",
    "task_id": "transform",
    "run_id": "scheduled__2024-01-15T00:00:00+00:00",
    "execution_date": "2024-01-15T00:00:00+00:00",
    "try_number": 1
  }
}

name: CI Pipeline

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install dependencies
        run: npm install

      - name: Ping PingPulse - Install Complete
        run: |
          curl -X POST "${{ secrets.PINGPULSE_URL }}?stagePath=1&start=yes" \
            -H "Content-Type: application/json" \
            -d '{"stage": "install", "commit": "${{ github.sha }}"}'

      - name: Run tests
        run: npm test

      - name: Ping PingPulse - Tests Complete
        run: |
          curl -X POST "${{ secrets.PINGPULSE_URL }}?stagePath=2" \
            -H "Content-Type: application/json" \
            -d '{"stage": "test", "status": "passed"}'

      - name: Build
        run: npm run build

      - name: Ping PingPulse - Build Complete
        run: |
          curl -X POST "${{ secrets.PINGPULSE_URL }}?stagePath=3&final=yes" \
            -H "Content-Type: application/json" \
            -d '{"stage": "build", "artifact": "dist/"}'

#!/bin/bash
# backup.sh

set -e  # Exit on error

# Your backup logic
pg_dump -h localhost mydb > /backups/mydb_$(date +%Y%m%d).sql
aws s3 cp /backups/mydb_$(date +%Y%m%d).sql s3://my-backups/

# Ping PingPulse on success
curl -fsS "https://app.pingpulse.com/hhk/MONITOR_ID?key=API_KEY" > /dev/null