Start in the Fictix Console
Fictix is Console-first. The Console is where a team creates a synthetic company, controls access, manages billing, and obtains the project-scoped key used to connect that company to server-side code.
Open the frontend before making your first runtime API request: create an account, or sign in and open your projects.
1. Sign in and select an organization
Sign in, then create or select the organization that owns the test company. New users land in Organizations after account creation; existing users can manage organizations at the same frontend route. Organization roles control who can create companies, manage keys, configure webhooks, and manage billing.
Do not share a single organization across unrelated customers or environments. Use a separate organization or project for each isolated test-company context.
2. Create or select a test company
Use Generate a company for a new company, or open your projects for an existing one. The Console owns the user-facing setup flow; API consumers do not need to construct an internal project record by hand.
When generation completes, the project has:
- a project id and slug
- generated, synthetic company data
- selected service capabilities
- a project-scoped runtime API key
- a Connect panel with copyable server-side setup details
3. Create a company API key
In staging, the company's API page also lets you select an integration, issue a company key, and copy its first request. Follow Connect your software for the expanded provider catalog and the correct JSON, XML, form, or execute transport.
For one key covering all companies in an organization, staging admins and owners can instead use Organization settings → Organization API keys. See One key for multiple companies.
Open Company settings, then use Company API keys to create a key. Copy the secret when it is shown and store it in your server-side secret manager. The Console only displays the full key at creation or rotation time.
Use the key with the generated company's runtime routes:
X-API-Key: <project_api_key>
Never put this key in browser JavaScript, a public environment variable, a mobile app, a screenshot, or a git repository.
Console management session
The signed-in Console uses a WorkOS-backed bearer session for its own management actions, including company creation and webhook administration. The Console manages that session in the app; it is not a copyable customer credential, has no environment variable for customers, and must not be forwarded from browser code.
4. Use the Connect panel
The project's Connect to your builder panel gives you the runtime API origin, company slug, company API key, and a sample request. Use the values from that panel to configure your server-side integration:
FICTIX_API_ORIGIN="https://api.fictix.ai"
FICTIX_PROJECT_SLUG="<project_slug>"
FICTIX_PROJECT_API_KEY="<project_api_key>"
FICTIX_API_ORIGIN is the origin only; append the documented route path in your request. For staging, use https://api-staging.fictix.ai and a matching staging company and key. Keep these values in a server-side secret manager or an ignored local environment file. Do not put the key in browser code or a public environment variable.
5. Rotate or revoke keys in the Console
Project administrators can rotate or revoke keys from the same Company API keys area. Rotate a key when it may have been exposed; revoke it when the integration no longer needs access. Update your server-side secret before removing the old key from a live integration.
Console destinations
Every customer-facing setup task starts in the frontend. Link to these routes from a docs-site header, onboarding email, or product handoff instead of asking users to call a management API directly.
| Need | Frontend destination |
|---|---|
| Create an account | Create account |
| Sign in and see projects | Sign in |
| Create a test company | Generate |
| Open or select a company | Projects |
| Create, rotate, or revoke a company key | Company settings |
| Review organization access | Organizations |
| Manage billing or usage | Billing |
| Explore exports and API setup | Exports & API |
Which API should I use?
| Goal | Start here | Auth |
|---|---|---|
| Connect an existing test company to your app | Runtime routes under /api/v1/orgs/{slug} |
Project API key from the Console |
| Discover available entities and services | /api/v1/catalog/* |
No credential required |
| Create or control companies in the Console | /api/v1/demo-jobs |
Console-managed WorkOS bearer session (not copyable) |
| Create or control companies from an external integration | /api/v1/demo-jobs |
FICTIX_ADMIN_API_KEY / X-Admin-Key (Fictix-approved integrations only) |
The /demo-jobs control plane is intentionally not a browser-key flow. The
Console UI uses its managed WorkOS bearer session. For an approved
backend-to-backend integration, use FICTIX_ADMIN_API_KEY as X-Admin-Key,
supplied by Fictix. The Console's WorkOS bearer session is managed by the
Console and is not an external integration credential. Never use
email/password auth, copy a browser session token, or embed the admin key in a
frontend application. Normal customers should use the project X-API-Key
runtime flow above.
Next: Runtime And Native Routes or the Quickstart.
