Skip to main content
POST
Create a new auth link session

Authorizations

x-api-key
string
header
default:your-project-api-key
required

Your Composio project API key. Create or copy it from the Composio dashboard.

Body

application/json
auth_config_id
string<authConfigId>
required

The auth config id to create a link for

user_id
string
required

The user id to create a link for

Minimum string length: 1
alias
string

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

Maximum string length: 255
callback_url
string

The callback url to create a link for

connection_data
object

Optional data to pre-fill connection fields with default values

experimental
object

Experimental features - not stable, may be modified or removed in future versions.

Response

Successfully created auth link

The generated link token for the auth session

redirect_url
string
required

The redirect URI to send users to for authentication

expires_at
string
required

ISO timestamp when the link expires

connected_account_id
string<connectedAccountId>
required

The connected account ID that was created

experimental
object

Experimental features - not stable, may be modified or removed in future versions.