Skip to main content
POST
Create a deep link

Authorizations

Authorization
string
header
required

An API token for one organization. You create and revoke tokens in the dashboard. A token scoped to one App can reach only that App, so give that kind of token to an agent. An organization-wide token can create a short-lived one with POST /api/tokens.

Scopes

apps:write
OAuth

Change the organization's Apps: edit files, run commands, deploy, and manage Secrets.

apps:write
DPoP

Headers

Idempotency-Key
string

A key for this request, up to 200 printable characters. The request stores nothing, so a retry makes a new one whatever the key; the API returns the key in the Idempotency-Key response header.

Required string length: 1 - 200

Path Parameters

id
string
required

A unique ID that starts with app_.

Pattern: ^app_[0-9A-Za-z]{24}$
Example:

"app_Zj7XhMgplmTJcp5Dk4vcYuk0"

Body

application/json
page
enum<string>

The page to open. Without it, the link opens the App's usual first page.

Available options:
secrets,
access,
deploys,
logs,
preview
secrets
string[]

The Secrets to ask for, by name, from 1 to 20. The page has a field for each. Only with page set to secrets.

Required array length: 1 - 20 elements
Pattern: ^[A-Z_][A-Z0-9_]{0,127}$
reason
string

One sentence, up to 200 characters, on what the Secrets are for. The page shows it as your agent's words. Only with secrets.

Required string length: 1 - 200

Response

The deep link.

url
string<uri>
required

The link, for a person to open. It grants no access: the person signs in as usual and needs to be a member of the App's organization.

expires_at
string<date-time>
required

When the link stops working, 24 hours after it was created.

Example:

"2026-10-03T14:01:30.000Z"