Agent accounts
Get claim status
Check whether a person has claimed your agent account, and when it expires if not.
GET
/
v1
/
agents
/
claim
Get claim status
curl --request GET \
--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.get(url, headers=headers)
print(response.text)const options = {method: 'GET', 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 => "GET",
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("GET", 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.get("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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
}Returns the status of the agent account that owns the key. Use the account-wide key from Sign up an agent. A key scoped to one workspace gets
403.
Response
object
The agent account.
Show properties
Show properties
string
The account’s id.
string | null
The workspace made at signup.
string
unclaimed until a person claims it, then claimed. An account that expires loses its keys, so its key gets 401 instead of reading expired or deleted.string | null
When an unclaimed account expires.
null once claimed.string | null
When a person claimed it, or
null.Example
curl https://www.orgo.ai/api/v1/agents/claim \
-H "Authorization: Bearer $ORGO_API_KEY"
import os
import requests
res = requests.get(
"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', {
headers: { Authorization: `Bearer ${process.env.ORGO_API_KEY}` },
});
console.log(await res.json());
Response
{
"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" } | No key, or not a valid one. An expired agent account’s keys are deleted, so they get this too. |
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. |
503 | { "error": "…" } | Orgo could not verify the key because of a server-side fault. Retry after Retry-After. |
⌘I
Get claim status
curl --request GET \
--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.get(url, headers=headers)
print(response.text)const options = {method: 'GET', 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 => "GET",
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("GET", 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.get("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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
}