Sign in

v1

latestOpenAPI 3.1.02026-07-2210284274.4 KB
Member Agents

Update an agent

Update one registered agent identified by its url. The url field itself cannot be changed via PATCH — supplying a url in the body that differs from the path returns 400 url_immutable; re-register at the new URL and DELETE the old entry to migrate. All other fields accept partial updates.

patch/api/me/agents/{url}

Path parameters

urlstring required

The agent's url, URL-encoded (e.g. https%3A%2F%2Fagent.example.com%2Fmcp).

The agent's url, URL-encoded (e.g. https%3A%2F%2Fagent.example.com%2Fmcp).

Query parameters

orgstring

WorkOS organization id to act on. Defaults to the caller's primary organization. Use this from a multi-org session (or when shelling with a user JWT) to target a non-primary org. Verification goes through WorkOS membership lookup; non-members get 403.

Example:org_01HXZAB123

WorkOS organization id to act on. Defaults to the caller's primary organization. Use this from a multi-org session (or when shelling with a user JWT) to target a non-primary org. Verification goes through WorkOS membership lookup; non-members get 403.

Request body

namestring
visibility'private' | 'members_only' | 'public'

Visibility tier on the registry catalog. private = profile owner only; members_only = AAO API-tier members on operator lookup; public = listed in the public catalog and reflected in the org's brand.json (requires a paid AAO tier — Professional, Builder, Member, or Leader).

type'brand' | 'rights' | 'measurement' | 'governance' | 'creative' | 'sales' | 'buying' | 'signals'

Agent type the caller declares. Required on register; smuggle-protection still cross-checks against the capability snapshot when one exists. The server never infers type — the owner declares what kind of agent this is.

health_check_urlstring uri

Response

Agent updated.

org_auto_createdboolean

Set to true when this POST was the caller's first interaction with the registry and the server auto-created the organization (display name derived from the user's email domain for corporate emails, or <First Last>'s Workspace for free-email providers). Combined with profile_auto_created, this is the one-call storefront experience: a third-party app holding only an OAuth token gets the org, profile, and registered agent in a single request.

profile_auto_createdboolean

Set to true when this POST was the first agent registration on the caller's organization and the server auto-created a private member profile (display name = organization name, is_public: false). Absent on subsequent calls and on update-in-place. Surfaced so storefront-style integrations can show a "we set up your profile" hint without needing to detect the prior 404 → bootstrap → retry shape.

Example response

{
  "agent": {
    "url": "https://agent.example.com/mcp"
  }
}