Skip to main content
POST
Sign Up as an Agent
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.

Request

Send the email of the person you work for and a name they will recognize:
The name appears in the workspace’s member list.

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

Do not retry a 409 with another spelling of the same address. Each email gets one signup.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
email
string<email>
required

The email address of the person you work for. Disposable and example domains are refused.

Maximum string length: 254
agent_name
string
required

A name the person will recognize, such as Claude Code. It appears in the workspace's member list.

Required string length: 1 - 80

Response

The workspace and key were created.

status
string
required
Allowed value: "success"
agent_signup
object
required