Completion¶

POST /v1/completion is the engine's front door. You give it an input and a mode; it enqueues a run and returns a job envelope. The run itself is asynchronous — read the result from /v1/jobs/{id}.

Want to know the price first? Send the same body to POST /v1/completion/estimate — it answers what the run would cost without running anything or charging anything.

POST /v1/completion¶

Enqueue an engine run. Returns a pending JobStatus with an id of the form job-<uuid>.

Input: prompt or messages¶

Provide exactly one of these (supplying both or neither is a 422):

For messages, role is one of system, user, or assistant; the summed length of all content is capped at 500,000 characters (1–256 turns).

Body¶

Modes¶

Settings¶

settings is the single per-call override object. Every field is optional.

Examples¶

curl https://api.humx.ai/v1/completion \
  -H "Authorization: ApiKey $COMPANIONS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "prompt": "What are the trade-offs of optimistic locking?",
        "mode": "answer",
        "settings": { "temperature": 0.4 }
      }'

import os, requests

r = requests.post(
    "https://api.humx.ai/v1/completion",
    headers={"Authorization": f"ApiKey {os.environ['COMPANIONS_API_KEY']}"},
    json={
        "prompt": "What are the trade-offs of optimistic locking?",
        "mode": "answer",
        "settings": {"temperature": 0.4},
    },
)
r.raise_for_status()
job = r.json()
print(job["id"], job["status"])   # job-... pending

const res = await fetch("https://api.humx.ai/v1/completion", {
  method: "POST",
  headers: {
    Authorization: `ApiKey ${process.env.COMPANIONS_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    prompt: "What are the trade-offs of optimistic locking?",
    mode: "answer",
    settings: { temperature: 0.4 },
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const job = await res.json();
console.log(job.id, job.status); // job-... pending

interface JobStatus {
  id: string;
  kind: "completion" | "companion" | "team" | "forensics";
  status: "pending" | "running" | "complete" | "failed" | "requires_action";
  content?: unknown;
}

const res = await fetch("https://api.humx.ai/v1/completion", {
  method: "POST",
  headers: {
    Authorization: `ApiKey ${process.env.COMPANIONS_API_KEY!}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    prompt: "What are the trade-offs of optimistic locking?",
    mode: "answer",
    settings: { temperature: 0.4 },
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const job = (await res.json()) as JobStatus;

A multi-persona example — a parallel run across three companions:

{
  "prompt": "Should we adopt event sourcing for the orders service?",
  "mode": "parallel",
  "participants": ["architect", "sre", "product-lead"]
}

Response¶

200 — a pending job envelope. The answer arrives later via /v1/jobs/{id}.

{
  "type": "status",
  "id": "job-1a2b3c4d-...",
  "kind": "completion",
  "status": "pending",
  "mode": "answer"
}

Once complete, the same job carries a typed content keyed by shape:

{
  "id": "job-1a2b3c4d-...",
  "kind": "completion",
  "status": "complete",
  "content": {
    "shape": "answer",
    "companion": "Ada",
    "response": "Optimistic locking trades..."
  }
}

See Jobs → Result shapes for every mode's content.

Estimating a run¶

POST /v1/completion/estimate takes the exact same body as POST /v1/completion and answers what that run would cost instead of running it. Nothing is created and nothing is charged — no job, no balance movement. To budget a call, re-send what you were about to send:

curl https://api.humx.ai/v1/completion/estimate \
  -H "Authorization: ApiKey $COMPANIONS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "prompt": "Should we rewrite the billing service in Rust?",
        "mode": "panel",
        "participants": ["architect", "sre"]
      }'

{
  "mode": "panel",
  "currency": "USD",
  "estimable": true,
  "runs": 1,
  "estimate": { "expected": 0.0431, "low": 0.0189, "high": 0.1204 },
  "tokens": { "input": 38210, "output": 6100 },
  "calls":  { "expected": 14, "high": 14 },
  "confidence": "medium",
  "basis": "mixed",
  "caveats": [],
  "reasons": [],
  "balance": { "current": 2.5, "sufficient": true },
  "stages": [ { "...": "one row per stage, for auditing the total" } ]
}

Read it in this order: estimable → confidence and basis → estimate.expected and balance.sufficient → caveats and stages.

The band. expected prices the calls the run must make at each stage's typical output length; low is the same calls at the 10th percentile; high is every call — including optional ones such as a tool loop running to its cap — at the 90th percentile. Budget against expected; size headroom against high. Money has four decimal places, matching your billing ledger.

confidence (high / medium / low) is the worst grade of any input the estimate consumed. One stage with no usable history drags the whole record down — deliberately, so you never have to read stages[] to learn the number is soft.

basis says where the numbers came from:

estimable: false is an answer, not an error. A run whose cost cannot be known ahead of time comes back 200 with every number zeroed, balance.sufficient: null, and stable machine-readable tokens in reasons[] — for example run_structure_not_predictable:<mode> (the graph's shape is decided at run time), no_rate_for_model:<slug> (a model with no history and no catalogue price — unknown, not free), or resolution_failed:<code> (the same problem the real POST would refuse with a 4xx, e.g. an ambiguous companion name). Branch on reasons; caveats is the human-readable half and is free to change.

Client tools¶

Attach a tools array to declare functions the model can call on your machine (available for mode: "answer", with or without settings.crumbs). When the model calls one, the run pauses and hands the call back — the server never executes your tools. You run them and return the results via POST /v1/jobs/{id}/tool_outputs.

{
  "prompt": "What's in my workspace?",
  "mode": "answer",
  "tools": [
    {
      "name": "read_user_file",
      "description": "Read a file from the user's local workspace.",
      "parameters": {
        "type": "object",
        "properties": {
          "path": { "type": "string", "description": "Path relative to workspace root" }
        },
        "required": ["path"]
      }
    }
  ]
}

parameters is plain, provider-neutral JSON Schema. Bounds: up to 32 tools; each name matches ^[a-zA-Z_][a-zA-Z0-9_]*$ (1–64 chars, unique per request); parameters ≤ 16 KiB serialized. The full pause/resume loop lives on the Jobs page.

Validation¶

A 422 is returned before any run is enqueued when, for example:

Insufficient balance surfaces as 402 — before anything is enqueued when the budget guard prices the run above your balance (the body then carries estimate, balance, and shortfall), or when a running call is charged.