Documentation

How to connect your software, build an agent, read a run, and understand why something stopped for a person. Written alongside the code it describes.

Getting started

What this is, and how to get something working.

What an agent actually is

A saved configuration, not a personality.

Running without an AI provider key

What the built-in development model can and cannot do.

From nothing to a working agent

The whole path, in about ten minutes.

Agents

Building, configuring and versioning the thing that does the work.

Instructions that actually work

Be specific about refusals, not just about the job.

Versions and rolling back

Deploying keeps the old one. Nothing is overwritten.

Tools, and why an agent cannot exceed them

The complete list of things an agent can do.

Connections

Attaching your software, and what happens to the credentials.

Connecting software

MCP, REST or a database — and what happens to your credentials.

What happens to your credentials

Encrypted per secret, never in a prompt, never visible to us.

When a connection stops working

Credentials expire, hosts move, APIs get retired.

Approvals

What stops for a person, and why.

Why it stopped and asked me

Destructive and high-risk calls wait for a person.

Executions

Reading a run, and what to do when one goes wrong.

Cancelling does not undo

It stops further action. It cannot recall what already happened.

Reading an execution trace

Every decision in order, including the ones where nothing ran.

Chat

Talking to an agent, from here or from somewhere else.

Chat, and reaching an agent elsewhere

Same agent, same checks, different door.

Reports

Saved questions, tables and exports.

Reports

A saved question, run on demand or on a schedule.

Team

Who can do what, and how to change it.

Roles and what they can do

Five roles, and where the lines are drawn.

Two-factor authentication

The single most useful thing you can do for this account.

The audit log

Who did what, in an order that cannot be quietly edited.

Billing

Plans, limits, and what happens when a payment fails.

What happens if payment fails

Your workspace is restricted. Nothing is deleted.

Usage, quotas and what happens at the ceiling

Where the numbers come from and what runs out.

Support

Getting hold of a person.

Getting hold of a person

Tickets, what to include, and when to expect a reply.

Email

What we send, and how to stop it.

What we email you, and how to stop it

Service email and marketing email are different things.

Affiliates

Earning commission on businesses you introduce.

The affiliate programme

Commission on the first payment from businesses you introduce.

Developers

API keys, webhooks, and talking to AgentOS from your own code.

Webhooks

Get told when an agent finishes, fails, or needs a decision.

Not covered here?

A person reads every support ticket, and we would rather answer it than have you guess.

Get in touch