Ask the account owner for an API key (no key needed)

Emails the owner an approval link (they can sign up from it). Show them user_code, then poll GET /api/v1/agent/connect/{id}?secret=<poll_secret> every 10-30 seconds until status is approved. Always 202 for a valid body, whether or not the email has an account.

post/api/v1/agent/connect

Request

  • Base URL: https://www.premierletters.com
  • URL: https://www.premierletters.com/api/v1/agent/connect
  • Auth: none required

Request body

emailstring email required

The account owner's email; the approval link is sent here

agent_namestring required

Your name as the user will see it, e.g. "Claude". Letters, digits, spaces and . , ' & ( ) - _ only (no links).

mode'live' | 'test'

Response

Request created and approval email sent

request_idstring uuid
poll_urlstring uri
poll_secretstring

Pass as ?secret= when polling. Keep it private.

user_codestring

Short code (ABC-DEF) to show the user; the approval page repeats it

expires_atstring date-time
instructionsstring

Changes

No recorded changes to this operation across all 1 revision of this API.