Changelog
September 7, 2026 — Provider workflows in staging
- The staging catalog reported 60 entries: 59 marked available/selectable and one FCI execute preview, which is not selectable in the standard connector picker.
- The first-request directory covers every provider, including GraphQL, XML, form, and execute request bodies, and offers a downloadable JSON reference.
- The connection guide covers API keys, SDK base URLs, operation scopes, idempotency, and provider-level errors. The workflow reference documents the supported operations and limits.
- Public catalog snapshots observed October 28, 2026 report 60 entries in production as well as staging (59 marked available/selectable and one FCI preview). This is catalog metadata, not production request verification. Relay Financial remains unavailable pending a direct API contract. TriNet refers to HR Platform (formerly Zenefits), not PEO.
See Connect your software, Provider first requests, and Provider workflows.
September 5, 2026 — Organization keys in staging
- Organization admins can issue one API key for all current and future companies in their organization.
- The company directory returns IDs and runtime slugs, with pagination for large organizations.
- Keys support access scopes, expiry, rotation, revocation, and usage metadata.
- Existing company keys remain available. Organization keys are staging-only in this release.
See One key for multiple companies.
This changelog tracks the public developer API contract described by
docs/fictix-api. Internal backend changes should appear here only when they
change external behavior, documented limits, or integration expectations.
2026-07-17
Changed:
-
POST /api/v1/demo-jobsnow documents its typed ready-create envelope:regeneration_required, lifecycle timestamps, optional simulation/scenario summaries, and a settled credit receipt. - Create errors now distinguish invalid requests, management access, credit admission, idempotency/issuance conflicts, validation, and capacity limits.
- The generated Company and Partner OpenAPI references are refreshed from the live production contract during documentation validation.
Client action:
-
Accept the current create envelope and preserve
regeneration_requiredwith the job record. Regenerate a flagged company before a current-contract import. -
Handle both the usual
detailerror envelope and the create-time credit envelope witherrorandmessage.
Contract:
- version:
2026-07-17 - tested against: the live production OpenAPI contract
2026-07-13
Added:
- AI agent integration now maps the canonical agent brief to every major tool's instructions file (GitHub Copilot, Windsurf, Cline, Gemini CLI, JetBrains Junie, Replit Agent) instead of only Claude Code and Cursor.
- A browser-based app builder section (Lovable, v0, Bolt, Replit) with a paste-ready knowledge prompt teaching the server-side proxy pattern — project API keys never ship in generated frontend code.
Contract:
- version:
2026-07-05(unchanged — docs-only additions)
2026-07-12
Fixed:
-
The MCP server page documented env vars
fictix_mcpnever reads. The server readsFICTIX_BASE_URLandFICTIX_DEFAULT_SLUG(notFICTIX_API_ORIGIN/FICTIX_PROJECT_SLUG); the Claude Code, Codex, and Cursor config snippets are corrected. If you copied the old snippets, your sidecar was silently falling back to the production origin with no default slug — update your config. -
Replaced the undefined
$FICTIX_ACCESS_TOKEN/$FICTIX_BASE_URLnames in the entities-and-exports and skill-pack examples with the real ecosystem names (FICTIX_ADMIN_API_KEY,FICTIX_API_ORIGIN). - Removed a stale claim on AI agent integration that Fictix ships no MCP server.
Changed:
-
Authentication,
AGENTS.md, and the skill pack now name the complete set of credential env vars — the three self-service values plus the Fictix-suppliedFICTIX_ADMIN_API_KEY(approved partners only) — and explicitly instruct agents not to invent variable names or solicit Console session tokens. -
Start in the Console now maps the Connect
panel's variable names (
FICTIX_API_BASE_URL,FICTIX_API_KEY) to the convention used across these docs.
Contract:
- version:
2026-07-05(unchanged — docs-only corrections) -
client action: if you configured
fictix_mcpfrom the old MCP page snippets, renameFICTIX_API_ORIGIN→FICTIX_BASE_URLandFICTIX_PROJECT_SLUG→FICTIX_DEFAULT_SLUGin your MCP client config.
2026-07-11
Changed:
- Documented the Console-first onboarding flow for project creation, project API key issuance, rotation, revocation, organization access, and billing.
-
Clarified that
X-Admin-Keyis an approved server-to-server control-plane credential, not a self-service frontend key. - Added explicit production and staging API origins.
- Added response-envelope, capability-matrix, and version/compatibility references.
- Added OpenAPI security metadata and typed top-level partner response envelopes, plus CI validation for docs/OpenAPI drift.
X-Admin-Key is an approved server-to-server control-plane credential. It is
not a self-service frontend key.
Fixed:
- Updated example
contract_versionvalues to the current date-based string. - Corrected the stale 5,000-record bundle-cap example to the documented default of 25,000 records.
Contract:
- version:
2026-07-05 -
client action: treat
contract_versionas a string and begin onboarding in the Fictix Console.
2026-07-06
Added:
-
The ambulatory surgery center (
asc_surgical) clinical content pack: operating rooms, synthetic surgical cases, clinical incidents, and dictated incident scripts with extraction answer keys. - Five ASC scenario templates for extraction and compliance-style evaluation: ambiguous time references, duplicate staff names, unstated harm levels, mid-sentence corrections, and late reporting gaps.
Client action:
-
Select Ambulatory Surgery Center in the Console, or set
company.industrytoasc_surgicalfor an approved server-to-server create. - Treat the pack as synthetic evaluation data only. It contains no real patient data and is not for clinical decision-making.
Contract:
- version:
2026-07-05 - tested commit:
5f367d2
2026-07-01
Initial developer-docs source directory.
Added:
- start-here overview
- copy-paste quickstart
- authentication model
- demo job concept docs
- company blueprint docs
- entity, lineage, and count docs
- simulation concept docs
- catalog API reference
- demo jobs API reference
- entity and export API reference
- simulation, scenario, and event API reference
- test matrix and test run API reference
- runtime and native routes API reference
- webhook API reference
- error, limit, and idempotency reference
- build-a-demo-tenant guide
- load-into-your-app guide
- evaluate-your-app guide
- rate limit and quota resource
- production checklist
- OpenAPI and docs-site publishing guide
Contract notes:
/api/v1/demo-jobsis the preferred external API surface.paymentsis documented as an alias ofcustomer_payments.bill_paymentsis documented as an alias ofvendor_payments.- Canonical entity docs expect alias ledgers not to be double-counted.
- Runtime/org/native routes are advanced routes, not the first integration path.
- Webhooks are documented as feature-entitled, signed, SSRF-guarded, and async.
Operational notes:
- Public docs should be generated from this Markdown plus
/openapi.json. - Docs CI should fail on route drift, broken links, and contract-version changes without a changelog update.
Changelog policy
Use these labels:
| Label | Meaning |
|---|---|
| Added | New endpoint, field, entity, guide, or capability. |
| Changed | Behavior changed without removing compatibility. |
| Deprecated | Still works, but clients should migrate. |
| Removed | No longer available. Requires migration notes. |
| Fixed | Bug fix that affects documented behavior. |
| Security | Auth, data isolation, signature, SSRF, or secret-handling change. |
Every entry should include:
- affected endpoint or concept
- old behavior
- new behavior
- client action
- contract version
- tested commit or release id
Breaking change template
## YYYY-MM-DD
Changed:
- `GET /api/v1/demo-jobs/{job_ref}/entities/{entity}` now returns ...
Client action:
- Update parsers to read ...
Compatibility:
- Old field remains until ...
Contract:
- version: 2026-...
- tested commit: ...
