Workflow

Workflow endpoints allow candidates to run and iterate on AI workflow prompts during multi-phase assessments. The workflow executes a candidate-authored prompt against inbox data and returns the generated output.

Run Workflow

POST /api/workflow/run

Executes the candidate’s workflow prompt against the inbox emails for the current phase. The workflow runs as a tool-calling agent: it is given search_email, list_emails, and get_email tools (backed by the session’s phase inbox via InboxConnector) and loops until it produces a final summary output. Uses a fast model (gpt-4o-mini or claude-haiku) for quick iteration. Rate-limited to 10 runs per session.

This endpoint is authenticated via the candidate session token, not an API key. The session is resolved from that token — there is no sessionId body field.

string

required

The workflow prompt to execute as the system prompt

integer

Current phase index. Used to load the correct inbox data when multiple phases have different email sets.

Response

{
  "output": "## Weekly Deal Flow & Priority Digest\n\n...",
  "runNumber": 1,
  "maxRuns": 10
}

Error — Rate limited (429)

{
  "error": {
    "code": "rate_limited",
    "message": "Workflow run limit reached (10 runs per session)."
  }
}

Export Workflow Deliverable

GET /api/workflow/export

Exports the workflow deliverable for a session as a markdown file. Contains the final edited prompt, full run history (each prompt + output pair with timestamps), and any tool-call events logged during workflow runs. Used by admins to download a candidate’s workflow work.

string

required

The assessment session ID

string

Target a specific phase (for multi-phase assessments). When omitted, resolves the current/only phase.

Response

Returns a .md file download with Content-Type: text/markdown; charset=utf-8.

Error — No deliverable found

{
  "error": "No workflow deliverable found for this session."
}

Overview

Endpoints

Workflow

Workflow

Run Workflow

Export Workflow Deliverable

​Workflow

​Run Workflow

​Export Workflow Deliverable

Workflow

Run Workflow

Export Workflow Deliverable