Onboarding

Create an account and get a key, with no human

Create a trial account and return a usable API key in one unauthenticated request. No email, no password, no card, no form: an agent that has found this description can be calling the API on the next line. The account is unclaimed, and claimUrl is what a person opens later to take ownership of it.

Contract published at https://app.zenrows.com/agent-onboarding/auth.md, and advertised as agent_auth.signup_endpoint in https://app.zenrows.com/.well-known/oauth-protected-resource.

post/api/agent/signup

Request

  • Base URL: https://app.zenrows.com
  • URL: https://app.zenrows.com/api/agent/signup
  • Auth: none required

Headers

X-ZR-Agent-Idstring

Optional provenance, anonymous and free of personal data.

X-ZR-Clientstring

Optional name of the calling client.

X-ZR-Sourcestring

Optional origin of the signup.

Request body

object required

No fields are required. An empty body is the normal call.

Response

The account exists and the key works immediately.

apiKeystring required

Pass it as the apikey query parameter to Fetch, or as X-API-Key to Batch.

accountIdstring uuid required
claimUrlstring uri required

Where a person claims this account. Surface it to a human; do not sit on it.

trialEndsAtstring date-time required

When the trial allowance stops.

Changes

No recorded changes to this operation across all 1 revision of this API.