DocsStart

Set up your workspace

Three ways to get connected. Your agent can do most of it for you.

Sign in at app.sioma.ai and your dashboard asks two questions: who this workspace is for, and how you work. Your answers pick one of the setup paths below. Nothing is locked in, and you can switch paths whenever you like.

Setup itself is short:

  1. Connect your agent. This turns green when your agent first reaches your cell, which can take a minute.
  2. Watch it learn. Real traffic sharpens what Sioma serves. Savings and grounding show up in Insights.

Adding an API spec is not a setup step. The agent paths below map your system themselves, and you can always manage specs later in Control room, under API spec.

Pick your path#

You only need one of these.

The fastest path, and the one that needs no key handling from you. The dashboard gives you a prompt. Paste it into your agent, and the agent scans your repo, publishes the spec, and connects itself.

When it needs credentials, it prints a short code and a URL. You open that URL in your browser, check that the code matches, and click Approve. That is the whole credential step, and there is nothing to copy or paste.

Only approve a code you just triggered yourself. If someone else sends you one, deny it.

If you work in Claude Code, install the plugin once:

/plugin marketplace add sioma-ai/claude-plugins
/plugin install sioma@sioma

That single install registers the Sioma MCP server plus two skills: extract-openapi and benchmark-questions. Then say:

onboard this repo to Sioma

The skill runs the full loop: find your API, scan it, publish it, and verify your agent can see the resulting map. Export SIOMA_API_KEY in your shell first and the plugin picks it up from there, so your key never sits in a config file.

The manual path, and the one to use for any agent that is not Claude Code:

  1. Create two API keys on the dashboard: scope agent for your tool's MCP connection, and scope publish for the CLI's sioma publish. Each is shown once, at the moment you create it, and never again. (The one-prompt path above skips this: the approval hands your agent both — the response's sioma_publish_key is exactly the SIOMA_PUBLISH_KEY the CLI reads.)
  2. Add the MCP server to your tool, pointed at your cell URL with the agent key. See Connect your agent for the config per tool.
  3. Map your system with the CLI and the publish key, or paste a spec into Control room. See Map your system.

Optional: let Sioma run the flows#

Once you are connected, the dashboard offers one more step. With rails on, your agent picks a flow and Sioma makes the API calls for it, using only call chains your published spec declares.

Rails are off by default and are enabled per workspace. If you want them on, talk to us and we will enable them for your workspace.

AI resources These docs are built to be read by your agent, not just by you.