WarpSearch

Check on a registration, and receive the API key once your user has approved it. Returns status: pending (not approved yet; ask your user to finish, then call again), approved (with api_key, shown only this once, and how to reconnect with it), denied, expired, or claimed (the key was already handed out).

{
  "type": "object",
  "properties": {
    "claim_token": {
      "type": "string",
      "description": "the claim_token register returned"
    }
  },
  "required": [
    "claim_token"
  ],
  "additionalProperties": false
}

Ask WarpSearch for an account and an API key for your user. Use only an email address your user gave you for this, with their consent. The address must be a work address at your user's organization's own domain. Personal and free mailbox providers (gmail.com, outlook.com, hotmail.com, yahoo.com, icloud.com, proton.me, disposable addresses and the like) are refused with code personal_email during the public preview; ask your user for their work address instead of retrying. WarpSearch emails that address. Your user follows the link, creates the account if they have none, checks that the code matches the user_code you show them, and approves, choosing the organization and the role you get. Nothing is created until they approve, and the answer is the same whether or not the address already has an account. Returns user_code (show it to your user), claim_token (keep it secret; pass it to claim_registration), expires_at and next_steps. Each address gets at most 3 sign-up emails an hour.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "your user's work email address, exactly as they gave it to you for this; free and personal mailbox providers (gmail.com, outlook.com, ...) are refused"
    },
    "name": {
      "type": "string",
      "description": "your user's name, if you know it (used in the email)"
    },
    "agent": {
      "type": "string",
      "description": "who you are, e.g. 'Claude Code on Ada's laptop'; shown to your user when they approve"
    },
    "role": {
      "type": "string",
      "description": "the role you ask for: admin (default; can also delete collections), editor (can also create collections and change mappings), writer (index into existing collections) or viewer (search only). Your user may lower it"
    }
  },
  "required": [
    "email"
  ],
  "additionalProperties": false
}