Jobs

{
  "run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": null,
  "status": "succeeded",
  "created_at": "2025-01-15T10:30:00Z",
  "started_at": "2025-01-15T10:30:02Z",
  "finished_at": "2025-01-15T10:31:14Z",
  "error_code": null,
  "error_message": null,
  "error_detail": null
}

{
  "run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": null,
  "status": "failed",
  "created_at": "2025-01-15T10:30:00Z",
  "started_at": "2025-01-15T10:30:02Z",
  "finished_at": "2025-01-15T10:30:08Z",
  "error_code": "SECURITY_RETURNS_MISSING",
  "error_message": "We are sorry. We could not find price data for INVALIDTICKER.NS in any of our sources, so we could not optimize this portfolio. Remove it and run it again.",
  "error_detail": {
    "type": "SecurityReturnsMissingError",
    "missing_tickers": ["INVALIDTICKER.NS"]
  }
}

curl https://api.foliolab.ai/jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer <YOUR_TOKEN>"

import requests

BASE_URL = "https://api.foliolab.ai"
TOKEN = "<YOUR_TOKEN>"
RUN_ID = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

headers = {"Authorization": f"Bearer {TOKEN}"}

response = requests.get(f"{BASE_URL}/jobs/{RUN_ID}", headers=headers)
response.raise_for_status()

job = response.json()
print(f"Status: {job['status']}")

if job["status"] == "failed":
    print(f"Error: {job['error_code']}: {job['error_message']}")

{
  "items": [
    {
      "run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Large caps, Q1",
      "created_at": "2025-01-15T10:30:00Z",
      "status": "succeeded",
      "has_pdf": false,
      "tags": [{ "name": "production", "color": "#22c55e" }],
      "methods": ["MVO", "HRP"],
      "method_count": 2,
      "stock_count": 5,
      "fund_count": 0,
      "has_constraints": false,
      "mode": "retail",
      "metrics": { "sharpe": 0.87, "cagr": 0.162, "volatility": 0.213 },
      "facets": { "...": "..." }
    },
    {
      "run_id": "f9e8d7c6-b5a4-3210-fedc-ba9876543210",
      "name": null,
      "created_at": "2025-01-15T11:00:00Z",
      "status": "running",
      "has_pdf": false,
      "tags": [],
      "methods": ["MinVol"],
      "method_count": 1,
      "stock_count": 8,
      "fund_count": 0,
      "has_constraints": false,
      "mode": "retail",
      "metrics": { "sharpe": null, "cagr": null, "volatility": null },
      "facets": { "...": "..." }
    }
  ],
  "next_cursor": "eyJjIjoiMjAyNS0wMS0xNVQxMDozMDowMFoiLCJpIjoiYTFiMmMzZDQifQ=="
}

# First page
curl "https://api.foliolab.ai/jobs/history?limit=10" \
  -H "Authorization: Bearer <YOUR_TOKEN>"

# Next page (use next_cursor from previous response)
curl "https://api.foliolab.ai/jobs/history?limit=10&cursor=eyJjIjoiMjAyNS0wMS..." \
  -H "Authorization: Bearer <YOUR_TOKEN>"

import requests

BASE_URL = "https://api.foliolab.ai"
TOKEN = "<YOUR_TOKEN>"
headers = {"Authorization": f"Bearer {TOKEN}"}

# Fetch all jobs using cursor-based pagination
all_jobs = []
cursor = None

while True:
    params = {"limit": 20, "summary": "true"}
    if cursor:
        params["cursor"] = cursor

    resp = requests.get(f"{BASE_URL}/jobs/history", params=params, headers=headers)
    resp.raise_for_status()
    data = resp.json()

    all_jobs.extend(data["items"])
    cursor = data.get("next_cursor")

    if not cursor:
        break

print(f"Total jobs: {len(all_jobs)}")
for job in all_jobs:
    print(f"  {job['run_id'][:8]}...  {job['status']}  ({job['stock_count']} stocks)")

{
  "run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "succeeded",
  "artifacts": [
    {
      "artifact_id": "5b0c9e2a-...",
      "method": null,
      "kind": "data",
      "label": "chart_bundle",
      "content_type": "application/json",
      "bytes": 759495,
      "sha256": "...",
      "created_at": "2025-01-15T10:31:12Z",
      "signed_url": "<presigned-url - expires in 1h>"
    },
    {
      "artifact_id": "7d4e1f3b-...",
      "method": null,
      "kind": "data",
      "label": "optimization_report",
      "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
      "bytes": 214880,
      "sha256": "...",
      "created_at": "2025-01-15T10:31:12Z",
      "signed_url": "<presigned-url - expires in 1h>"
    }
  ],
  "data_parquets": {},
  "data_files": {
    "chart_bundle": "<presigned-url - expires in 1h>",
    "optimization_report": "<presigned-url - expires in 1h>"
  }
}

curl https://api.foliolab.ai/jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/artifacts \
  -H "Authorization: Bearer <YOUR_TOKEN>"

import requests
import os

BASE_URL = "https://api.foliolab.ai"
TOKEN = "<YOUR_TOKEN>"
RUN_ID = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

headers = {"Authorization": f"Bearer {TOKEN}"}

# Fetch artifact metadata
resp = requests.get(f"{BASE_URL}/jobs/{RUN_ID}/artifacts", headers=headers)
resp.raise_for_status()
data = resp.json()

# Download each artifact using its signed URL
output_dir = f"./results/{RUN_ID[:8]}"
os.makedirs(output_dir, exist_ok=True)

EXTENSIONS = {
    "application/json": "json",
    "application/pdf": "pdf",
    "application/vnd.apache.parquet": "parquet",
    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": "xlsx",
}

for artifact in data["artifacts"]:
    ext = EXTENSIONS.get(artifact["content_type"], "bin")
    filename = f"{artifact['label']}.{ext}"
    filepath = os.path.join(output_dir, filename)

    print(f"Downloading {artifact['label']}...")
    download = requests.get(artifact["signed_url"])
    download.raise_for_status()

    with open(filepath, "wb") as f:
        f.write(download.content)

# Legacy runs only: Parquet data files
for name, url in data["data_parquets"].items():
    filepath = os.path.join(output_dir, f"{name}.parquet")
    print(f"Downloading {name}.parquet...")
    download = requests.get(url)
    with open(filepath, "wb") as f:
        f.write(download.content)

print(f"\nAll artifacts saved to {output_dir}/")