Background Agents

Get Background Agent Connect Link

Returns the link that connects one of the agent's MCP servers.

A background agent is not a user, so it cannot hold a connection of its own — it runs an MCP server as the connected account of an org member (auth_mode: "connected_user"). That is the person themselves for a personal assistant, or a dedicated bot user (for example an Okta service account) for a shared agent.

Without user_email the link is for the account the agent is already configured to use. This endpoint only reads: pass user_email to preview a link for another account, or use POST to also point the agent at that account.

get/api/background-agents/{id}/auth-url

Request

Base URL: https://app.withwillow.ai
URL: https://app.withwillow.ai/api/background-agents/{id}/auth-url
Auth: HTTP bearer

Path parameters

idstring required

The ID of the background agent

Query parameters

integrationstring required

Slug of the MCP server to connect

user_emailstring

Connect this account instead of the one the agent is configured with. Must already exist in the organization.

Response

Connect link generated successfully

Example response

{
  "data": {
    "integration": "github",
    "user_email": "bot-github@acme.com",
    "url": "https://acme.withwillow.ai/acme/api/auth/init?state=..."
  }
}

Changes

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