Skip to content

Quickstart

This guide walks through creating an account, generating an API key, and making your first request. The whole flow takes about two minutes.

Create an account from the console:

Pick the region your data should live in. We do not move customer data between regions, and API keys are bound to the region they were issued in — a ah_sk_us_… key only works against api.us.autohost.app.

In the console, open Settings → API Keys → Create key and choose:

  • Modetest for development, live for production traffic.
  • Scopes — at minimum applicants:write and sessions:write for the examples below.

The key is shown once. Copy it immediately and store it in a secrets manager (1Password, AWS Secrets Manager, Cloudflare Secrets, etc). The key looks like:

ah_sk_us_test_<43 random chars>

The prefix encodes region (us / eu) and mode (test / live); the SDK uses it to pick the right endpoint automatically.

Identify the key with GET /v1/me:

Terminal window
curl -i https://api.us.autohost.app/v1/me \
-H "Authorization: Bearer ah_sk_us_test_<your-key>"

Successful response:

{
"data": {
"id": "key_01ABC",
"object": "api_key",
"org_id": "org_01XYZ",
"mode": "test",
"region": "us",
"scopes": ["applicants:write", "sessions:write"]
}
}

Every response includes an X-Request-Id header. Surface it in your logs — support tickets that include the request ID get triaged faster.

  • Browse the interactive reference to see every endpoint.
  • Read the error code reference so your client handles the full envelope, including request_id and doc_url.
  • An official TypeScript SDK ships in a follow-up release. Until then, treat the wire shapes documented in the reference as the contract — they are generated from the same Zod schemas the server uses to validate input, so they will not drift.