Tool Router

Create a link session for a toolkit in a tool router session

Changed on

Initiates an authentication link session for a specific toolkit within a tool router session. Returns a link token and redirect URL that users can use to complete the OAuth flow.

post/api/v3.1/tool_router/session/{session_id}/link

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/tool_router/session/{session_id}/link
  • Auth
    API key in header x-api-key

Path parameters

session_idstring toolRouterSessionId required

The session ID returned when creating the session

Example:trs_LX9uJKBinWWr

The unique identifier of the tool router session

Request body

toolkitstring required

The unique slug identifier of the toolkit to connect

aliasstring

A human-readable alias for this connected account. Must be unique per entity and toolkit within the project.

callback_urlstring uri

URL where users will be redirected after completing auth

Example request

{
  "toolkit": "github",
  "callback_url": "https://myapp.com/callback"
}

Response

Successfully created link session. Returns link token, redirect URL, and connected account ID.

link_tokenstring required

Token used to complete the authentication flow

redirect_urlstring uri required

The URL where users should be redirected to complete OAuth

connected_account_idstring connectedAccountId required

The unique identifier for the connected account

Example response

{
  "link_token": "lt_abc123xyz",
  "redirect_url": "https://app.composio.dev/link/lt_abc123xyz",
  "connected_account_id": "ca_abc123xyz"
}

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id postV3_1ToolRouterSessionBySessionIdLink removed and replaced with postToolRouterSessionBySessionIdLink

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 589a7d115a5eRevision changes
    • info

      the endpoint scheme security CookieAuth was removed from the API

    • info

      the endpoint scheme security UserApiKeyAuth was removed from the API