Route index

Every route in the spec of the release api.felix.run runs, one line each. A route a guide explains links to that section; the rest link to their operation in the OpenAPI explorer, which has the request schema and a request builder but not the response shape — every harness route returns a plain object, so the spec cannot describe one. The REST API and Management API guides are where those shapes are written down.

178 routes, 141 of them explained in a guide.

• System 6
• A2A 1
• Approvals 3
• Artifacts 1
• Audit 3
• Auth 14
• Threads 37
• Repos 5
• Documents 4
• Eval 8
• Files 3
• Internal 1
• Jobs 6
• Manifests 7
• MCP 2
• Memory 6
• Plans 4
• Push 3
• Skill library 42
• Skills 3
• Triggers 1
• Usage 3
• OpenAI 2
• Workflows 13

System

• GET /.well-known/agent-card.jsonAgent CardREST API, Well-known
• GET /.well-known/jwks.jsonJWKSREST API, Well-known
• GET /healthLiveness — {"status":"ok","env":…,"version":…,"multi_region":false,"federation":null}REST API, System
• GET /liveLiveness, named for what it is — the same static body as /health, no I/OREST API, System
• GET /metricsPrometheus text exposition.REST API, System
• GET /readyReadiness. Probes the dependencies and answers 503 when one is down, so a pod with a dead database leaves rotation instead of being restartedREST API, System

A2A

• POST /a2aA2A RPCExplorer, POST /a2a

Approvals

• GET /approvalsApprovals awaiting a decision, newest first.Management API, GET /approvals
• GET /approvals/{approval_id}Get ApprovalExplorer, GET /approvals/{approval_id}
• POST /approvals/{approval_id}/decideDecide ApprovalManagement API, POST /approvals/{approval_id}/decide

Artifacts

• GET /artifacts/{manifest_id}/{artifact_id}Get ArtifactManagement API, Artifacts

Audit

• GET /auditList AuditManagement API, GET /audit
• GET /audit/exportEvery matching event as JSONL, newest first — the whole range, not a page.Management API, GET /audit/export
• GET /audit/metricsRoll up recent ``tool_call`` audit rows for the inspector metrics panel.Management API, GET /audit/metrics

Auth

• POST /auth/github/actionsRedeem Github Actions LoginREST API, From GitHub Actions
• GET /auth/github/authorizeSend a browser to GitHub to sign in, returning to `return_to` (an allowed origin).REST API, GitHub login
• GET /auth/github/callbackGitHub's return. Checks `state` against this browser's flow cookie, exchanges the code, mints, and redirects back to the app with the token waiting in a one-load cookie.REST API, GitHub login
• POST /auth/github/deviceStart Github LoginREST API, GitHub login
• POST /auth/github/exchangeThe app collects the token its sign-in left waiting, once.REST API, GitHub login
• POST /auth/github/tokenRedeem Github LoginREST API, GitHub login
• GET /auth/google/authorizeSend a browser to Google to sign in, returning to `return_to` (an allowed origin).REST API, GitHub login
• GET /auth/google/callbackGoogle's return. Checks `state` against this browser's flow cookie, exchanges the code, verifies the ID token, checks the allowlist, mints, and redirects back to the app with the token waiting in a one-load cookie.REST API, GitHub login
• POST /auth/google/exchangeThe app collects the token its sign-in left waiting, once.REST API, GitHub login
• GET /auth/methodsWhich ways in this deployment offers, for a client that holds no credential yet.REST API, GitHub login
• DELETE /github/connectionForget your GitHub connection here and withdraw the App's authorization at GitHub.Explorer, DELETE /github/connection
• GET /github/connectionWhether Felix holds a GitHub connection for you in this tenant.Explorer, GET /github/connection
• GET /github/connectionsEvery stored GitHub connection in your tenant (`github:admin`).Explorer, GET /github/connections
• DELETE /github/connections/{github_user_id}Revoke anyone's GitHub connection in your tenant (`github:admin`).Explorer, DELETE /github/connections/{github_user_id}

Threads

• POST /chatRun a turn. With an `Idempotency-Key`, run it once per key per principal.REST API, POST /chat
• POST /chat/abortChat AbortREST API, Abort, continue, thinking, compact
• POST /chat/askAnswer one question from a thread's context, leaving the thread exactly as it was.REST API, Abort, continue, thinking, compact
• POST /chat/compactChat CompactREST API, Abort, continue, thinking, compact
• POST /chat/continueResume after abort/error without a new user message (wake-based).REST API, Abort, continue, thinking, compact
• POST /chat/forkCopy a thread's active branch into a new thread, recording the source as its parent.Explorer, POST /chat/fork
• DELETE /chat/history/{thread_id}Reset the session logREST API, Sessions
• GET /chat/history/{thread_id}Flat transcript, newest window — {thread_id, messages, events, oldest_seq, has_more}REST API, Sessions
• POST /chat/modeSet the thread's permission mode: `default`, `plan`, `accept_edits` or `bypass`.REST API, Abort, continue, thinking, compact
• POST /chat/rewindChat RewindExplorer, POST /chat/rewind
• GET /chat/runs/{resume_token}Poll a durable chat fiber started with ``spec.execution.mode: durable``.Explorer, GET /chat/runs/{resume_token}
• GET /chat/sessionsList sessions, newest first, one page at a time — {sessions:[…], items:[…], next_cursor}.REST API, Sessions
• POST /chat/sessions/custom{thread_id, content, in_context, metadata, role}REST API, Sessions
• POST /chat/sessions/feedback{thread_id, event_id, rating: "up" \| "down" \| null, note?} — rate an assistant turnREST API, Sessions
• POST /chat/sessions/label{thread_id, event_id, label}REST API, Sessions
• POST /chat/sessions/leaseTake or renew a hold: `exclusive` drives the thread, `shared` observes it read-only.Explorer, POST /chat/sessions/lease
• POST /chat/sessions/lease/releaseDrop the one hold `token` names; every other hold stays.Explorer, POST /chat/sessions/lease/release
• POST /chat/sessions/name{thread_id, name} — also appends a session_info eventREST API, Sessions
• GET /chat/sessions/searchPostgres full-text search — {query, hits}REST API, Sessions
• GET /chat/sessions/{thread_id}Authoritative snapshotREST API, Sessions
• GET /chat/sessions/{thread_id}/exportActive branch as JSONL (application/x-ndjson, attachment)REST API, Sessions
• GET /chat/sessions/{thread_id}/leaseWho holds the thread: the exclusive holder, if any, and every observer.Explorer, GET /chat/sessions/{thread_id}/lease
• POST /chat/steerQueue a steer (interrupt remaining tools) or follow-up (after idle) message.Explorer, POST /chat/steer
• POST /chat/streamRun a turn as an SSE stream.REST API, POST /chat/stream
• GET /chat/stream/{thread_id}Reattach to a thread after a dropped connection or a page refresh.REST API, GET /chat/stream/{thread_id}
• POST /chat/styleSet how the thread's agent writes: one of the manifest's `spec.output_styles`, or `null` for its default.REST API, Abort, continue, thinking, compact
• POST /chat/thinkingChat ThinkingREST API, Abort, continue, thinking, compact
• POST /chat/tool_resultComplete a client-executed tool that paused the active agent run.Explorer, POST /chat/tool_result
• POST /chat/uiResolve a pending select/confirm/input prompt from the web client.Explorer, POST /chat/ui
• POST /chat/workspace/deleteDelete one workspace file, and tell the agent.REST API, Reading and writing the workspace
• POST /chat/workspace/delete_folderDelete one workspace folder and everything in it, and tell the agent.REST API, Reading and writing the workspace
• POST /chat/workspace/editedTell the agent the operator edited, deleted or renamed a workspace file directly.Explorer, POST /chat/workspace/edited
• GET /chat/workspace/fileOne workspace file, whole, from the workspace `GET /chat/workspace/tree` lists.REST API, Reading and writing the workspace
• POST /chat/workspace/renameMove one workspace file to another path in the same workspace, and tell the agent.REST API, Reading and writing the workspace
• POST /chat/workspace/rename_folderMove one workspace folder to another path in the same workspace, and tell the agent.REST API, Reading and writing the workspace
• GET /chat/workspace/treeEvery file and directory in the thread's workspace, for the operator's file pane.REST API, Reading and writing the workspace
• POST /chat/workspace/writeReplace one workspace file with the operator's text, and tell the agent.REST API, Reading and writing the workspace

Repos

• DELETE /chat/sessions/{thread_id}/workspace/repoDelete this thread's checkout.Explorer, DELETE /chat/sessions/{thread_id}/workspace/repo
• GET /chat/sessions/{thread_id}/workspace/repoThis thread's checkout: its state, and once ready, its branch, commits ahead and whether it has uncommitted changes.Explorer, GET /chat/sessions/{thread_id}/workspace/repo
• POST /chat/sessions/{thread_id}/workspace/repoClone a repository you can reach into this thread's checkout.Explorer, POST /chat/sessions/{thread_id}/workspace/repo
• GET /chat/sessions/{thread_id}/workspace/repo/filesThe files in this thread's checkout — tracked, and untracked but not ignored — each with its size and git status, sorted by path.Explorer, GET /chat/sessions/{thread_id}/workspace/repo/files
• GET /github/reposThe repositories you can open: where the App is installed and you have access.Explorer, GET /github/repos

Documents

• GET /documentsDocuments in this tenant's corpus, newest first.Management API, Documents
• POST /documentsIngest or replace one document.Management API, Documents
• GET /documents/searchHybrid retrieval over the corpus, with the channels that surfaced each hit.Management API, Documents
• DELETE /documents/{doc_id}Remove a document and every chunk of it.Management API, Documents

Eval

• GET /eval/datasetsList DatasetsManagement API, Eval
• GET /eval/datasets/{name}Get DatasetManagement API, Eval
• PUT /eval/datasets/{name}Write a dataset whole — name, description and items.Management API, Eval
• POST /eval/datasets/{name}/runDeprecated: `POST /eval/runs` with `dataset_name` in the body starts the same run.Management API, Eval
• GET /eval/runsList Eval RunsManagement API, Eval
• POST /eval/runsStart Eval RunManagement API, Eval
• POST /eval/runs/compareComparative eval: baseline vs candidates on one dataset.Management API, Eval
• GET /eval/runs/{run_id}Get Eval RunManagement API, Eval

Files

• POST /filesStore bytes and return the id a later message can reference.Management API, Files
• DELETE /files/{file_id}Remove an upload.Management API, Files
• GET /files/{file_id}Read an upload back, base64-encoded as it was sent.Management API, Files

Internal

• POST /internal/sessions/{session_id}/eventsAppend a queue write-back event after content screening.Explorer, POST /internal/sessions/{session_id}/events

Jobs

• GET /jobsList JobsManagement API, Jobs
• DELETE /jobs/{name}Delete JobManagement API, Jobs
• GET /jobs/{name}Get JobManagement API, Jobs
• PUT /jobs/{name}Create or replace a job. It runs as `cron` on behalf of whoever wrote it last, with their scopes: the manifest's inbound auth is checked against them on every firing, so writing a job reaches no manifest the writer could not run by asking.Management API, Jobs
• POST /jobs/{name}/runRun a job now, without waiting for its schedule, and return the run.Management API, Jobs
• GET /jobs/{name}/runsList Job RunsManagement API, Jobs

Manifests

• GET /manifestsList ManifestsExplorer, GET /manifests
• GET /manifests/{name}Resolve a manifest as a request would see it.Explorer, GET /manifests/{name}
• PUT /manifests/{name}Upsert ManifestManagement API, PUT /manifests/{name}
• DELETE /manifests/{name}/canaryClear CanaryManagement API, Canary and rollback
• POST /manifests/{name}/canarySet CanaryManagement API, Canary and rollback
• POST /manifests/{name}/rollbackRollback ManifestManagement API, Canary and rollback
• GET /manifests/{name}/versionsThe stored versions of a manifest, newest first — what a rollback can go back to.Explorer, GET /manifests/{name}/versions

MCP

• GET /mcpMCP InfoREST API, MCP
• POST /mcpMCP RPCREST API, MCP

Memory

• GET /memoryActive memories, newest first; or, with `status=forgotten`, the forgotten ones, most recently forgotten first.Management API, Memory
• POST /memoryStore a memory directly.Management API, Memory
• GET /memory/as-of/{turn_seq}What was believed at a past turn, including facts since superseded.Management API, Memory
• GET /memory/searchHybrid recall — the same ranking the agent sees, so an operator can reproduce it.Management API, Memory
• DELETE /memory/{memory_id}Hide a memory from recall.Management API, Memory
• POST /memory/{memory_id}/restoreUndo a forget: the memory is recalled again.Management API, Memory

Plans

• GET /plansPlans, most recently updated first.Management API, Plans
• DELETE /plans/{plan_id}Delete PlanManagement API, Plans
• GET /plans/{plan_id}Get PlanManagement API, Plans
• PUT /plans/{plan_id}Upsert PlanManagement API, Plans

Push

• DELETE /push/subscriptionsForget this browser. Not an error when it was never subscribed.Management API, DELETE /push/subscriptions
• POST /push/subscriptionsRegister (or refresh) this browser.Management API, POST /push/subscriptions
• GET /push/vapid-public-keyThe application server key a browser passes to `pushManager.subscribe`.Management API, GET /push/vapid-public-key

Skill library

• GET /skill-libraryA library's skills by name -- the tenant's, or under `~{library}` a person's -- each with its live and newest version.Management API, Skill library
• POST /skill-librarySave a new skill as an operator draft (version 0.1.0), and publish it if `publish`.Management API, Skill library
• GET /skill-library/-/browseThe skills a GitHub repository offers at one commit: every directory with a `SKILL.md` under the usual roots (`skills/`, `.claude/skills/`, Claude Code plugin layouts, …), with the name and description its frontmatter declares.Management API, Skill library
• GET /skill-library/-/feedbackFeedback across every skill in one status (`pending` by default), oldest first: the one that has waited longest is the one to read next.Management API, Skill library
• POST /skill-library/-/feedback/{feedback_id}/acceptAccept pending feedback. With `improve` (the default) the worker rewrites the skill from it into a draft for review; the feedback moves to `applied` with `result_version`, or to `failed` with `error`.Management API, Skill library
• POST /skill-library/-/feedback/{feedback_id}/rejectReject pending feedback, recording the note.Management API, Skill library
• POST /skill-library/-/importFetch the skill at `source`, pinned to the commit `ref` resolves to, and save it as a draft.Management API, Skill library
• GET /skill-library/-/personalEvery personal library in the tenant, for an administrator: whose it is, its digest -- the `~{library}` that reads or archives it -- and how many skills it holds, archived ones included.Management API, Skill library
• DELETE /skill-library/-/policyDrop the tenant's own policy, so the settings alone decide; returns the policy now in force.Management API, Skill library
• GET /skill-library/-/policyThe gate every publish and rollback passes: the deployment's `FELIX_SKILL_PUBLISH_*` settings, tightened by the tenant's own policy when it has one.Management API, Skill library
• PATCH /skill-library/-/policySet fields of the tenant's own publish policy; returns the policy now in force.Management API, Skill library
• GET /skill-library/-/reviewEvery draft in the tenant awaiting a decision, oldest first, across skills.Management API, Skill library
• GET /skill-library/-/upstreamThe tenant's imported skills, by name, each against its origin: the upstream commit, whether its files moved from the newest version's (`update_available`), and when the cooldown lets them in.Management API, Skill library
• DELETE /skill-library/{name}Take a skill out of every catalog.Management API, Skill library
• GET /skill-library/{name}One skill and every version it holds (metadata only; files are read per version).Management API, Skill library
• POST /skill-library/{name}/-/updateRe-import an imported skill from its stored origin, exactly as `POST /-/import` would: a new draft (201), or 200 `unchanged`; `too_recent` inside the cooldown, `origin_mismatch` if the name's newest version came from elsewhere.Management API, Skill library
• GET /skill-library/{name}/-/upstreamAn imported skill against its origin now: the commit the ref names, whether the kept files moved, when this tenant first saw them and when the cooldown lets them in, and a per-file diff against the live version (the newest when nothing is live).Management API, Skill library
• GET /skill-library/{name}/evalsOne skill's evaluations, newest first, optionally of one version.Management API, Skill library
• GET /skill-library/{name}/evals/{eval_id}One evaluation, with each scenario's prompt, both scores and the judge's reasons.Management API, Skill library
• GET /skill-library/{name}/feedbackOne skill's feedback, newest first, optionally in one status.Management API, Skill library
• POST /skill-library/{name}/feedbackFile feedback on a skill as the caller (`source: human`), on `target_version` or the live version.Management API, Skill library
• PUT /skill-library/{name}/versionsSave a new version of an existing skill, edited from `parent_version`.Management API, Skill library
• GET /skill-library/{name}/versions/{version}One version: its review record, the checks and scan findings it was saved with, and its files' digests.Management API, Skill library
• POST /skill-library/{name}/versions/{version}/adoptVouch for an imported version: save its files, byte for byte, as a new operator draft built on it that no longer carries `lineage_import`, recording who adopted it, why, and from which version (`adopted_from`).Management API, Skill library
• POST /skill-library/{name}/versions/{version}/evalQueue an evaluation of a version; the worker runs it within a minute.Management API, Skill library
• GET /skill-library/{name}/versions/{version}/files/{path}One file of a version, checked against the digest recorded when it was saved.Management API, Skill library
• GET /skill-library/{name}/versions/{version}/previewRe-run review and the security scan on the stored bytes and say whether the publish policy would pass them.Management API, Skill library
• POST /skill-library/{name}/versions/{version}/publishPublish a draft: it becomes the live version, and the version it replaces is archived.Management API, Skill library
• POST /skill-library/{name}/versions/{version}/rejectArchive a draft without publishing it, recording the note.Management API, Skill library
• POST /skill-library/{name}/versions/{version}/rollbackMake a version that was once live, live again -- through the same gate as a publish, without its evaluation requirement.Management API, Skill library
• GET /skill-library/~{library}A library's skills by name -- the tenant's, or under `~{library}` a person's -- each with its live and newest version.Explorer, GET /skill-library/~{library}
• POST /skill-library/~{library}Save a new skill as an operator draft (version 0.1.0), and publish it if `publish`.Explorer, POST /skill-library/~{library}
• DELETE /skill-library/~{library}/{name}Take a skill out of every catalog.Explorer, DELETE /skill-library/~{library}/{name}
• GET /skill-library/~{library}/{name}One skill and every version it holds (metadata only; files are read per version).Explorer, GET /skill-library/~{library}/{name}
• PUT /skill-library/~{library}/{name}/versionsSave a new version of an existing skill, edited from `parent_version`.Explorer, PUT /skill-library/~{library}/{name}/versions
• GET /skill-library/~{library}/{name}/versions/{version}One version: its review record, the checks and scan findings it was saved with, and its files' digests.Explorer, GET /skill-library/~{library}/{name}/versions/{version}
• GET /skill-library/~{library}/{name}/versions/{version}/files/{path}One file of a version, checked against the digest recorded when it was saved.Explorer, GET /skill-library/~{library}/{name}/versions/{version}/files/{path}
• GET /skill-library/~{library}/{name}/versions/{version}/previewRe-run review and the security scan on the stored bytes and say whether the publish policy would pass them.Explorer, GET /skill-library/~{library}/{name}/versions/{version}/preview
• POST /skill-library/~{library}/{name}/versions/{version}/promotePropose a version of your own library to the tenant's: its files, byte for byte, saved as a draft of the tenant's skill of the name (`source: promoted`, `promoted_from` naming your version), for the tenant's ordinary review queue.Explorer, POST /skill-library/~{library}/{name}/versions/{version}/promote
• POST /skill-library/~{library}/{name}/versions/{version}/publishPublish a draft: it becomes the live version, and the version it replaces is archived.Explorer, POST /skill-library/~{library}/{name}/versions/{version}/publish
• POST /skill-library/~{library}/{name}/versions/{version}/rejectArchive a draft without publishing it, recording the note.Explorer, POST /skill-library/~{library}/{name}/versions/{version}/reject
• POST /skill-library/~{library}/{name}/versions/{version}/rollbackMake a version that was once live, live again -- through the same gate as a publish, without its evaluation requirement.Explorer, POST /skill-library/~{library}/{name}/versions/{version}/rollback

Skills

• GET /skills/{manifest_name}Every skill this manifest can reach, and which are currently active.Management API, Skills
• GET /skills/{manifest_name}/activations/recentWhich skill activated on which turn, newest first.Management API, Skills
• GET /skills/{manifest_name}/{skill_name}One skill, including the instructions `activate_skill` would return.Management API, Skills

Triggers

• POST /triggers/{trigger_id}Receive TriggerREST API, POST /triggers/{id}

Usage

• GET /usageUsage rows, newest first, each with the cost it was priced at.Management API, GET /usage
• GET /usage/summarySpend grouped by manifest, model and UTC day, with totals.Management API, GET /usage/summary
• GET /usage/threadsSpend grouped by thread over a window, most recently active first.Management API, GET /usage/threads

OpenAI

• POST /v1/chat/completionsChat CompletionsREST API, OpenAI-compatible surface
• GET /v1/modelsList bundled + discoverable manifests as OpenAI models with Felix catalog metadata.REST API, OpenAI-compatible surface

Workflows

• GET /workflowsThe tenant's workflows, most recently saved first, without their definitions.Management API, Workflows
• POST /workflows/-/checkPorts and problems for a definition, without saving it — what the editor shows as you wire.Management API, Workflows
• GET /workflows/-/kindsThe step kinds a workflow can use: built in, and any a plugin registered.Management API, Workflows
• GET /workflows/-/toolsThe tools a `tool_call` step naming `manifest` can call, with their input schemas.Management API, Workflows
• DELETE /workflows/{workflow_id}Delete a workflow; with `If-Match`, only that revision.Management API, Workflows
• GET /workflows/{workflow_id}Get WorkflowManagement API, Workflows
• PUT /workflows/{workflow_id}Save a definition whole. `201` when this created it, `200` when it replaced one.Management API, Workflows
• GET /workflows/{workflow_id}/runsThe workflow's runs, newest first, each with its steps' statuses.Management API, Workflows
• POST /workflows/{workflow_id}/runsStart a run of the workflow's current revision with `inputs`.Management API, Workflows
• GET /workflows/{workflow_id}/runs/{run_id}Get RunManagement API, Workflows
• POST /workflows/{workflow_id}/runs/{run_id}/cancelAsk the run to stop: `cancelling` until the orchestrator aborts what is in flight.Management API, Workflows
• GET /workflows/{workflow_id}/runs/{run_id}/steps/{step_id}/threadThe transcript of one step's child run: the snapshot `GET /chat/sessions/{id}` answers.Management API, Workflows
• GET /workflows/{workflow_id}/runs/{run_id}/streamThe run as it changes: a `workflow_run` frame for each new version, then `[DONE]` once over.Management API, Workflows