The Runs API

curl -X POST "https://<your-app-hostname>/v1/files" \
  -H "Authorization: Bearer $DYNAMIQ_ACCESS_KEY" \
  -F "file=@report.pdf"

import os
import requests

endpoint = "https://<your-app-hostname>"
headers = {"Authorization": f"Bearer {os.getenv('DYNAMIQ_ACCESS_KEY')}"}

with open("report.pdf", "rb") as f:
    response = requests.post(f"{endpoint}/v1/files", headers=headers,
                             files={"file": f})

file = response.json()["data"]
print(file["id"], file["name"], file["size"], file["mime_type"])

const endpoint = "https://<your-app-hostname>";
const headers = { Authorization: `Bearer ${process.env.DYNAMIQ_ACCESS_KEY}` };

import { readFile } from "node:fs/promises";

const form = new FormData();
form.append("file", new Blob([await readFile("report.pdf")]), "report.pdf");

const response = await fetch(`${endpoint}/v1/files`, {
  method: "POST",
  headers,
  body: form,
});
const { data: file } = await response.json();
console.log(file.id, file.name, file.size, file.mime_type);

curl -X POST "https://<your-app-hostname>/v1/runs" \
  -H "Authorization: Bearer $DYNAMIQ_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input": {"question": "What can you do?"}}'

import os
import requests

endpoint = "https://<your-app-hostname>"
headers = {"Authorization": f"Bearer {os.getenv('DYNAMIQ_ACCESS_KEY')}"}

response = requests.post(f"{endpoint}/v1/runs", headers=headers,
                         json={"input": {"question": "What can you do?"}})

run = response.json()["data"]
print(run["status"], run["output"])

const endpoint = "https://<your-app-hostname>";
const headers = {
  Authorization: `Bearer ${process.env.DYNAMIQ_ACCESS_KEY}`,
  "Content-Type": "application/json",
};

const response = await fetch(`${endpoint}/v1/runs`, {
  method: "POST",
  headers,
  body: JSON.stringify({ input: { question: "What can you do?" } }),
});
const { data: run } = await response.json();
console.log(run.status, run.output);

curl -N -X POST "https://<your-app-hostname>/v1/runs" \
  -H "Authorization: Bearer $DYNAMIQ_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input": {"question": "What can you do?"}, "stream": true}'

import asyncio
import json
import os

import httpx

endpoint = "https://<your-app-hostname>"
token = os.getenv("DYNAMIQ_ACCESS_KEY")  # Generate Access Key in the UI settings
headers = {"Authorization": f"Bearer {token}"}

payload = {
    "input": {
        "question": "What can you do?"
    },
    "stream": True,
}

run_id: str | None = None
hitl_request_id: str | None = None
hitl_ready = asyncio.Event()


async def stream_events(client: httpx.AsyncClient) -> None:
    global run_id, hitl_request_id
    async with client.stream(
        "POST",
        f"{endpoint}/v1/runs",
        json=payload,
        headers=headers,
        timeout=None,
    ) as response:
        async for raw in response.aiter_lines():
            if not raw.startswith("data: "):
                continue
            event = json.loads(raw.removeprefix("data: "))
            print(event)
            if event["type"] == "run.created":
                run_id = event["data"]["id"]
            elif event["type"] == "agent.human_feedback.requested":
                hitl_request_id = event["data"]["id"]
                hitl_ready.set()


async def main() -> None:
    async with httpx.AsyncClient() as client:
        stream_task = asyncio.create_task(stream_events(client))

        # Optional: answer a human-feedback pause while the stream runs.
        # await hitl_ready.wait()
        # await client.post(
        #     f"{endpoint}/v1/runs/{run_id}/input",
        #     json={"type": "human_feedback", "data": {"request_id": hitl_request_id, "feedback": "cancel"}},
        #     headers=headers,
        # )

        await stream_task


asyncio.run(main())

const endpoint = "https://<your-app-hostname>";
const token = process.env.DYNAMIQ_ACCESS_KEY;  // Access key should be securely stored
const headers = {
  "Content-Type": "application/json",
  Authorization: `Bearer ${token}`,
};

const payload = {
  "input": {
    "question": "What can you do?"
  },
  "stream": true
};

let runId: string | null = null;
let hitlRequestId: string | null = null;

async function streamEvents() {
  const response = await fetch(`${endpoint}/v1/runs`, {
    method: "POST",
    headers,
    body: JSON.stringify(payload),
  });

  const reader = response.body!.getReader();
  const decoder = new TextDecoder();
  let buffer = "";

  while (true) {
    const { done, value } = await reader.read();
    if (done) break;
    buffer += decoder.decode(value, { stream: true });

    let idx: number;
    while ((idx = buffer.indexOf("\n")) !== -1) {
      const raw = buffer.slice(0, idx).trim();
      buffer = buffer.slice(idx + 1);
      if (!raw.startsWith("data: ")) continue;
      const event = JSON.parse(raw.slice("data: ".length));
      console.log(event);

      if (event.type === "run.created") runId = event.data.id;
      else if (event.type === "agent.human_feedback.requested") {
        hitlRequestId = event.data.id;
        // Answer it: POST `${endpoint}/v1/runs/${runId}/input` with
        // { type: "human_feedback", data: { request_id: hitlRequestId, feedback: "..." } }
      }
    }
  }
}

await streamEvents();

curl "https://<your-app-hostname>/v1/runs?status=awaiting_input&user_id=user-42" \
  -H "Authorization: Bearer $DYNAMIQ_ACCESS_KEY"

import os
import requests

endpoint = "https://<your-app-hostname>"
headers = {"Authorization": f"Bearer {os.getenv('DYNAMIQ_ACCESS_KEY')}"}

response = requests.get(f"{endpoint}/v1/runs", headers=headers,
                        params={"status": "awaiting_input", "user_id": "user-42"})
body = response.json()
for run in body["data"]:
    print(run["id"], run["status"], run["started_at"])

const endpoint = "https://<your-app-hostname>";
const headers = { Authorization: `Bearer ${process.env.DYNAMIQ_ACCESS_KEY}` };

const params = new URLSearchParams({ status: "awaiting_input", user_id: "user-42" });
const response = await fetch(`${endpoint}/v1/runs?${params}`, { headers });
const body = await response.json();
for (const run of body.data) console.log(run.id, run.status, run.started_at);

curl -X POST "https://<your-app-hostname>/v1/runs/$RUN_ID/input" \
  -H "Authorization: Bearer $DYNAMIQ_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "approval_request.confirmed",
    "data": {
      "request_id": "7e1d9b2a-3c4f-4a5b-8d6e-9f0a1b2c3d4e",
      "data": {"amount": 100}
    }
  }'

import os
import requests

endpoint = "https://<your-app-hostname>"
headers = {"Authorization": f"Bearer {os.getenv('DYNAMIQ_ACCESS_KEY')}"}

run_id = "0f6a2d4e-8b3c-4f1a-9d2e-7c5b6a4f3e21"
hitl_request_id = "7e1d9b2a-3c4f-4a5b-8d6e-9f0a1b2c3d4e"

requests.post(
    f"{endpoint}/v1/runs/{run_id}/input",
    headers=headers,
    json={
        "type": "human_feedback",
        "data": {"request_id": hitl_request_id, "feedback": "Looks good, proceed."},
    },
).raise_for_status()

const endpoint = "https://<your-app-hostname>";
const headers = {
  Authorization: `Bearer ${process.env.DYNAMIQ_ACCESS_KEY}`,
  "Content-Type": "application/json",
};

const runId = "0f6a2d4e-8b3c-4f1a-9d2e-7c5b6a4f3e21";
const hitlRequestId = "7e1d9b2a-3c4f-4a5b-8d6e-9f0a1b2c3d4e";

await fetch(`${endpoint}/v1/runs/${runId}/input`, {
  method: "POST",
  headers,
  body: JSON.stringify({
    type: "human_feedback",
    data: { request_id: hitlRequestId, feedback: "Looks good, proceed." },
  }),
});