Skip to main content
POST
Start Agent Onboarding

Overview

No authentication is required for this endpoint, it’s how a bot gets an API key in the first place. See Connect your AI agent for the full flow.
Requests are rate-limited globally and per IP. A 429 includes a Retry-After header in seconds.

Body Parameters

string
A name for the bot starting the flow, shown to the owner during signup so they know what’s asking. Max length 64. Allowed characters: letters, numbers, spaces, and ._/-.

Response

object
Device and user codes for the flow.
string
Opaque code your bot polls with at /v1/agent/onboarding/poll. Keep this private.
string
Short code to show the owner. They enter this at verification_url if it isn’t already pre-filled.
string
The page where the owner completes signup, without the code embedded.
string
The same page with user_code pre-filled. Prefer this when you can show a clickable link.
number
Seconds until the codes expire (900, 15 minutes).
number
Minimum seconds to wait between calls to /poll.
null | array
null on success.

Docs for agents: llms.txt