Sign in
Tool Router

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

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

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

Changed in 5 of the 61 revisions of this API.128

  • 589a7d115a5e2See the full diff
    • ○

      the endpoint scheme security CookieAuth was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security UserApiKeyAuth was removed from the API

      api-security-removed

  • 166dca8a495b122See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 23348819b35e1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 55e9c3b27c952See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 52c71f747c651See the full diff
    • ○

      endpoint added

      endpoint-added