Agent signups
Refresh claim link
Get a new claim link and code for your agent account when the old one is lost or has expired.
POST
/
v1
/
agents
/
claim
Refresh the claim link
curl --request POST \
--url https://www.orgo.ai/api/v1/agents/claim \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.orgo.ai/api/v1/agents/claim"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.orgo.ai/api/v1/agents/claim', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.orgo.ai/api/v1/agents/claim",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.orgo.ai/api/v1/agents/claim"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.orgo.ai/api/v1/agents/claim")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.orgo.ai/api/v1/agents/claim")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"claim": {
"url": "https://www.orgo.ai/claim/cXV1eGNvcmdlZm9vYmFyYmF6",
"code": "P3W-H8N-2RT",
"expires_at": "2026-10-15T10:00:00.000Z"
},
"account": {
"id": "a1c2e3f4-1111-4222-8333-444455556666",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "unclaimed",
"expires_at": "2026-10-11T09:00:00.000Z",
"claimed_at": null
}
}Makes a new claim link and code. The previous link and code stop working. Use the account-wide key from Sign up an agent. Works until a person claims the account. Limited to 20 new links an hour per account.
Give
claim.url to your person. They open it, sign in to Orgo, and accept. See Let an agent sign up on its own for what claiming does.
This endpoint takes no body.
Response
url, the link a person opens to claim the account; code, a short XXX-XXX-XXX code to show them; and expires_at, when the link stops working (7 days from now).The account’s status:
id, workspace_id, status, expires_at, and claimed_at, as in Get claim status.Example
curl -X POST https://www.orgo.ai/api/v1/agents/claim \
-H "Authorization: Bearer $ORGO_API_KEY"
import os
import requests
res = requests.post(
"https://www.orgo.ai/api/v1/agents/claim",
headers={"Authorization": f"Bearer {os.environ['ORGO_API_KEY']}"},
)
print(res.json())
const res = await fetch('https://www.orgo.ai/api/v1/agents/claim', {
method: 'POST',
headers: { Authorization: `Bearer ${process.env.ORGO_API_KEY}` },
});
console.log(await res.json());
Response
{
"claim": {
"url": "https://www.orgo.ai/claim/cXV1eGNvcmdlZm9vYmFyYmF6",
"code": "P3W-H8N-2RT",
"expires_at": "2026-10-15T10:00:00.000Z"
},
"account": {
"id": "a1c2e3f4-1111-4222-8333-444455556666",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "unclaimed",
"expires_at": "2026-10-11T09:00:00.000Z",
"claimed_at": null
}
}
Errors
| Status | Body | Meaning |
|---|---|---|
401 | { "error": "Invalid API key", "docs": "https://www.orgo.ai/auth.md" } | Not a valid key, with a WWW-Authenticate: Bearer realm="Orgo API" header. With no key, error is Authentication required. |
403 | { "error": "Use the account-wide key from signup.", "code": "workspace_scoped_key" } | A key scoped to one workspace. |
404 | { "error": "This API key isn’t for an agent account.", "code": "not_agent_account" } | The key belongs to an account that was not made by agent signup. |
409 | { "error": "This account was already claimed.", "code": "already_claimed" } | A person already claimed it. |
429 | { "error": "Too many new claim links this hour. Use the last one.", "code": "rate_limited", "retry_after": 1200 } | More than 20 this hour. Retry after Retry-After. |
500 | { "error": "Couldn’t make a new claim link. Try again.", "code": "server_error" } | Try again. |
503 | { "error": "…" } | Orgo could not verify the key because of a server-side fault. Retry after Retry-After. |
⌘I
Refresh the claim link
curl --request POST \
--url https://www.orgo.ai/api/v1/agents/claim \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.orgo.ai/api/v1/agents/claim"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.orgo.ai/api/v1/agents/claim', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.orgo.ai/api/v1/agents/claim",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.orgo.ai/api/v1/agents/claim"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.orgo.ai/api/v1/agents/claim")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.orgo.ai/api/v1/agents/claim")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"claim": {
"url": "https://www.orgo.ai/claim/cXV1eGNvcmdlZm9vYmFyYmF6",
"code": "P3W-H8N-2RT",
"expires_at": "2026-10-15T10:00:00.000Z"
},
"account": {
"id": "a1c2e3f4-1111-4222-8333-444455556666",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "unclaimed",
"expires_at": "2026-10-11T09:00:00.000Z",
"claimed_at": null
}
}