Inferrex Developers

1. Get started

You need three things: a workspace, an API key, and one call that proves the key works.

Create a workspace

  1. Go to https://app.inferrex.com and sign in.
  2. If your account is not a member of a workspace yet, the app says "This account has no Inferrex workspace". Choose Create a workspace.
  3. On "Create your workspace", accept the terms and create it.

If a colleague already has a workspace, ask them to invite you instead (Workspace settings, Members and invites).

Your work happens inside an environment. Development is free. Chapter 7 covers environments.

Find your way around the app

Area What you do there
Home See what needs you and what is happening now.
Systems Connect systems, review their objects and fields, manage sign-in and sync timing.
Flows Build and run flows. All mappings, Automations and Migrations are lists under Flows.
Golden records Browse the single best version of each record and decide proposed changes.
Review One queue for safety stops, sign-ins, failed writes, repair questions, Golden-record changes and approvals. Health and alerts, and Repairs, are views under it.
Reports Read-only answers about your workspace.
Workspace settings Environments, members, API keys, Connected assistants, Secrets, alert rules, outbound webhooks.

Create an API key

To create a key in the app:

  1. Open Workspace settings, then API keys.
  2. Start a new API key and name it after the code or job that will use it.
  3. Choose what it may do. Pick the least it needs:
    • reads everything it can see and changes nothing,
    • reads, creates and changes, but cannot delete,
    • every scope the API publishes, deleting included.
  4. Choose when it stops working.
  5. Copy the key. It is shown once. Store it in your deployment's secret store.

If you lose a key, deactivate it and make a new one. A deactivated key stops working straight away and cannot be turned back on.

To create a further key from code, call POST /v1/settings/api-keys (MCP tool settings_create_api_key). A key can only be given permissions that the key or person creating it already has.

Make a first call

List your systems:

curl https://api.inferrex.com/v1/connections \
  -H "X-API-Key: $INFERREX_API_KEY"

The response is { connections: [...] }. A new workspace returns an empty list.

A key only ever sees its own workspace. There is no key that crosses workspaces.

Choose how you work

All three surfaces run the same operations against the same workspace.

Surface Use it when Chapter
InferrexAPI You want plain HTTPS and JSON from any language. 8
InferrexMCP You want an AI coding tool to do the work with you. 9
InferrexCLI, the cloud shell A system signs in through its own command-line tool. 10

Next: connect a system.