← Back to Docs White-Label overview
RAG White-Label

Create an API account

Provision one isolated end-customer index per signup, addressed by your own customer id, with idempotent retries and automatic bundle growth.

Raw markdown guide for AI
Guide contents
llm prompts Implement provisioning Make my retries safe Validate uid and site_url

An api_account is a user account: one of your customers, with their own isolated index. It is distinct from you, the white-label organisation, which holds all of these user accounts and the provisioning token that manages them. Create one per customer, usually at signup.

uid is required: your own stable customer id. It is the idempotency key and the address for every later call, so you never need to store a Context Link id.

site_url is optional: include it if you know the customer's website; omit it for an account you fill with content you push or with the customer's own connected sources.

201 Created. Store the token now:

Request fields

uidstring
Required. Your own stable customer id: a-z, 0-9, hyphen, underscore or dot, 1 to 255 characters, unique per organisation. It is the idempotency key and the address for every later call.
labelstring
Optional display name, 255 characters or fewer, defaulting to the uid. This is the "label" column on the fleet screen.
site_urlstring
Optional http(s) URL. When present a website index is created and the first crawl starts immediately. We keep the host, plus a non-root path which becomes the crawl's starting point, and always crawl over https on the default port. A URL carrying an explicit port or embedded credentials is rejected rather than silently trimmed.
webhook_urlstring
Optional http(s) URL. Overrides your organisation default for this customer only.

Response fields

api_accountobject
The account that was provisioned or replayed.
api_account.idinteger
Context Link's own id for the account; you address it by uid, so you never need to store this.
api_account.uidstring
The customer id you provisioned the account with.
api_account.labelstring
The account's display name, falling back to the uid when you sent none.
api_account.site_urlstring
The website that will be crawled, null when the account was created without a site_url.
api_account.connection_idinteger
The website connection's id, null when the account has no website.
api_account.sync_statusstring
The crawl state: unsynced, syncing, synced, error_syncing, or no_site for an account with no website.
api_account.webhook_urlstring
The per-customer webhook override, null when the account falls back to your organisation default.
api_account.created_attimestamp
When the account was first provisioned.
tokenstring
The account's query token, returned on creation and again on every replay.
bundle_addedboolean
Whether this call added a bundle of 10 slots to your subscription.

Token-bearing responses are sent Cache-Control: no-store.

Retries are safe

If the response gets lost, POST the same uid again. You get 200 with the existing account and the same token, and nothing is created twice.

A replay deliberately ignores a changed body, including an invalid one: re-POSTing with a different site_url or label will not mutate the existing account and will not 422. So a retry needs no special casing, and needs to carry no more than the uid.

Automatic growth: if this was customer #11 on 1 bundle, a bundle is added automatically (+$50/mo, +10 slots) and the response carries "bundle_added": true. If the charge fails, the call returns 402 and no account is created. Bundles never shrink automatically; downgrade seats from billing if you want to.

← Back to Docs Raw markdown guide for AI