Agents

Start an agent authorization (code with PKCE)

The authorization endpoint. A browser is sent here by an agent; the request is validated (the client, the exact redirect URI, S256 PKCE, the scopes, the resource) and the browser is redirected to the console, where a signed in owner or admin sees what the agent asks for and where its code would go, and approves or denies. The authorization code goes to the redirect URI and is exchanged at POST /oauth/agent/token. A request with an unregistered or mismatched redirect URI is refused without redirecting. client_id is a registered client or an https URL of a Client ID Metadata Document.

get/oauth/agent/authorize

Request

  • Base URL: https://api.customdomain.ai
  • URL: https://api.customdomain.ai/oauth/agent/authorize
  • Auth: none required

Query parameters

client_idstring required
redirect_uristring uri required
response_type'code' required
code_challengestring required

BASE64URL(SHA-256(code_verifier)).

code_challenge_method'S256' required
scopestring required
Example:domains:read domains:connect

Space separated scopes from domains:read, domains:connect, domains:disconnect and domains:purchase. The person may approve fewer.

statestring
resourcestring uri

RFC 8707. The resource the token is for: the MCP endpoint (https://mcp.customdomain.ai/mcp, the default) or this API's origin. Anything else is invalid_target. The access token carries it as aud.

Changes

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