Skip to main content
POST
Create a connect link

Authorizations

Authorization
string
header
required

An API key (onx_sk_…) created in OnlyX under Settings → API & MCP, or an OAuth access token (onx_at_…) issued to a connected app. Send it as Authorization: Bearer <credential>. API keys may also be sent as X-API-Key: <key>.

Headers

Idempotency-Key
string

Optional and not needed: this call is idempotent on its own, so repeating it is always safe and no response is stored for replay. A key you send is still checked (8 to 64 letters, digits, - or _; a malformed one is 400 VALIDATION_ERROR).

Required string length: 8 - 64
Pattern: ^[A-Za-z0-9_-]{8,64}$

Path Parameters

creatorId
string
required

The creator id (cre_…).

Response

The active connect link (a live one is returned instead of a new one).

createdAt
string | null
required

When the link was created.

expiresAt
string | null
required

When the link stops working (24 hours after creation).

lastOpenedAt
string | null
required

When it was last opened.

opens
integer
required

How many times the link was opened. More opens than you expect can mean the link leaked: revoke it and create a new one.

status
enum<string>
required

active: can be opened now. used: she connected with it (links are burned on success). expired: older than 24 hours. revoked: you cancelled it. none: no link was ever created.

Available options:
active,
used,
expired,
revoked,
none
url
string | null
required

The link to send her. Anyone holding it can start the sign-in for this creator, so send it only to her. null unless status is active.