Sign Up as an Agent
Create an Orbit workspace for the person you work for and get an API key at once, with no sign-in.
POST
/
v3
/
agents
/
signup
Sign Up as an Agent
curl --request POST \
--url https://api.orbitsearch.com/v3/agents/signup \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "jane@company.com",
"agent_name": "Claude Code"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'jane@company.com', agent_name: 'Claude Code'})
};
fetch('https://api.orbitsearch.com/v3/agents/signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.orbitsearch.com/v3/agents/signup"
payload = {
"email": "jane@company.com",
"agent_name": "Claude Code"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"status": "success",
"agent_signup": {
"id": "6f1c2a1e-1f7c-4a43-9b8e-2d3c9a0b5e11",
"status": "unclaimed",
"organization_id": "0b6f7c55-3c1e-4c2b-8f4a-5d7e9a1b2c3d",
"email": "jane@company.com",
"api_key": "sk_orb_REDACTED",
"api_key_scopes": [
"search:read",
"profile:read"
],
"signup_credits": 200,
"sign_up_url": "https://developer.orbitsearch.com/signup"
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}An AI agent calls this endpoint to start using Orbit right away. No API key is
required. Orbit creates a workspace with the signup credits and returns an API
key for the agent. See Let Your Agent Sign Up for the full flow.
The name appears in the workspace’s member list.
Do not retry a
Request
Send the email of the person you work for and a name they will recognize:{ "email": "jane@company.com", "agent_name": "Claude Code" }
Response
api_key is returned only once. Store it in your private credential storage,
then send it as Authorization: Bearer sk_orb_... on Search, Enrich, and profile
reads. It has the search:read and profile:read scopes.
sign_up_url is Orbit’s sign-up page. Give it to the person and ask them to sign
up with the same email. Orbit then adds them to the workspace as its owner, and
your key keeps working. Orbit does not contact the person itself.
Errors
| Status | Code | What to do |
|---|---|---|
400 | agent_signup_invalid_email | Send the person’s email address. |
400 | agent_signup_email_not_allowed | Use the person’s real address, not a disposable or example domain. |
400 | agent_signup_invalid_agent_name | Send a short, readable agent_name. |
409 | agent_signup_email_has_account | The person already has an Orbit account. Ask them to sign in and connect you. |
409 | agent_signup_already_exists | An agent already created a workspace for this email. The person can sign up with this email to own it. |
503 | agent_signup_unavailable | Signup is paused or temporarily unavailable. Wait for Retry-After, or ask the person to sign in. |
409 with another spelling of the same address. Each email gets
one signup.Authorizations
Body
application/json
⌘I
Sign Up as an Agent
curl --request POST \
--url https://api.orbitsearch.com/v3/agents/signup \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "jane@company.com",
"agent_name": "Claude Code"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'jane@company.com', agent_name: 'Claude Code'})
};
fetch('https://api.orbitsearch.com/v3/agents/signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.orbitsearch.com/v3/agents/signup"
payload = {
"email": "jane@company.com",
"agent_name": "Claude Code"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"status": "success",
"agent_signup": {
"id": "6f1c2a1e-1f7c-4a43-9b8e-2d3c9a0b5e11",
"status": "unclaimed",
"organization_id": "0b6f7c55-3c1e-4c2b-8f4a-5d7e9a1b2c3d",
"email": "jane@company.com",
"api_key": "sk_orb_REDACTED",
"api_key_scopes": [
"search:read",
"profile:read"
],
"signup_credits": 200,
"sign_up_url": "https://developer.orbitsearch.com/signup"
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}