AGagentmail-to
apps

Connect App

Changed on

Starts signing an inbox in to an app. Returns a single-use magic_url, valid for five minutes, to open in the client that will hold the sign-in; the client enrolls as the inbox and continues to the app. An app in the catalog can be named by its slug, as in POST /v0/apps/firecrawl/connect. A 404 names the missing resource: App or Inbox. A 403 AppSignupLimitError means the app accepts no more sign-ups from your organization; sign in with an inbox that already has an account there.

post/v0/apps/{app_id}/connect

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/apps/{app_id}/connect
  • Auth
    HTTP bearer

Path parameters

app_idstring required

ID of app, or the slug of an app in the catalog. A slug ignores case, spaces and punctuation.

Request body

inbox_idstring

The ID of the inbox.

accept_disclosureboolean

Accept the app's disclosure on the agent's behalf, skipping the first-use disclosure page. Requires app_share_owner when owner scopes are involved.

Response

Response with status 202

api_key_idstring required

ID of api key.

magic_urlstring required

Single-use URL to open in the client that will hold the key.

expires_atstring date-time required

Time at which api key expires. Omitted when it does not expire.

Changes