The flow at a glance
- Sign up.
POST /v1/agentsreturnsapi_key, a workspace, a claim link, and $5 of starting credit. - Launch a computer by the hour.
POST /computerswith your workspace id and a name. - Use it. Run commands, take screenshots, click and type.
- Add credit. Ask for a Checkout link and send it to your person to pay.
- Hand over the claim link. A person opens it, signs in, and claims the account before it expires.
Step 1: Sign up
Authorization header is needed. Both body fields are optional: name (1 to 80 characters, used for the workspace name) and contact_email. Send no body at all and the account is still made.
The 201 response has everything the next steps need:
limits and next, is in Sign up an agent.
Step 2: Launch a computer by the hour
An unclaimed account runs Medium Linux computers (2 vCPU, 8 GB RAM, 40 GB disk), billed by the hour from its credit: the $5 starting credit first, then credit you add. Launching is one call. An agent account’s create is hourly by default, and Orgo quotes the Medium at its listed price for you.Idempotency-Key. If the launch fails partway, send it again with the same key and the same body: you get the original launch back instead of a second computer.
When the credit runs out, a launch returns 402 with code insufficient_credit. A launch that names another billing_mode returns 402 with code agent_account_prepaid_only: an unclaimed account has no plan to fund a computer and gets no free trial computer.
Step 3: Use the computer
$COMPUTER_ID is the id from the launch response.
Step 4: Add credit
The starting credit runs computers only. Add credit to keep a computer running, to use AI, and to unlock more computers and workspaces. Ask for a Checkout link and send it to your person to pay:amount_cents is 1000, 2500, 5000 or 10000 (25, 100). The answer is { "url": "…" }. The credit lands on the account once the person pays.
Once the account has bought $5 of credit in all, with none of it refunded or disputed, it can run up to 5 computers and hold up to 5 workspaces.
Step 5: Hand the claim link to a person
Give your personclaim.url from the signup response, and show them claim.code so they can check they are claiming the right account. They open the link, sign in to Orgo (or sign up), and accept. A person who has only the code can type it at https://www.orgo.ai/claim.
When they accept:
- They become an admin of the agent’s workspace and manage it from their own account.
- The unclaimed limits and the expiry stop applying.
- The agent’s key keeps working, and its credit keeps paying for its computer. Ownership and billing stay with the agent’s account.
403 with code claim_limit.
A claim link works for 7 days and only once. To get a new one, call Refresh the claim link. The previous link and code stop working. To check whether a person has claimed the account yet, call Get claim status.
Limits on an unclaimed account
Until a person claims it, the account is held to these limits:
A refused action answers with a
code that says why:
Expiry
An unclaimed account expires 72 hours after signup unless a person claims it.account.expires_at in the signup response gives the exact time.
- At expiry, every API key of the account is deleted, so the agent’s key stops working. Its running computer is stopped.
- For 2 days after expiry, a person can still claim the account with a claim link that has not expired. They get the stopped computer and can make the agent a new key.
- After those 2 days, the account’s computers are deleted. Credit the account bought stays on its record.
Retry signup safely with an Idempotency-Key
Send anIdempotency-Key header (8 to 255 printable characters, such as a UUID) so a dropped connection never makes a second account. Retry with the same key and the same body, and you get the first 201 back with Idempotent-Replayed: true. A replay does not count against the rate limits. Stored answers last 24 hours and are only replayed to the address that made the first request.
Rate limits
Signup is limited per address and network, and across everyone:
A refused request counts against none of them. Over a limit, the answer is
429:
Retry-After, then try again. If the limit cannot be checked, the answer is 503 with code unavailable and a Retry-After header. Retry after it.
Refreshing a claim link is limited to 20 an hour per account. It answers 429 with Retry-After the same way.