Skip to main content
POST
Start connecting a server for a profile

Authorizations

X-Api-Key
string
header
required

Personal or workspace LangSmith API key. Personal keys identify the user. Workspace keys are limited to server listing and MCP calls and must also supply the end user's OIDC token or X-LangSmith-Identity.

X-Tenant-Id
string
header
required

Workspace UUID. This header selects a workspace; it does not authenticate the caller.

Path Parameters

profile_id
string<uuid>
required

Profile ID

id
string
required

Workspace server ID or built-in catalog key

Response

Created

A link where an admin connects an MCP server's credential for a profile, or a credential already stored.

auth_id
string
required

Authorization session ID.

display_name
string
required

User-facing integration name.

kind
enum<string>
required

Authorization flow on the page: oauth or secret.

Available options:
oauth,
secret
slug
string
required

Credential connection slug.

status
enum<string>
required

Status is pending until the owner completes the page at VerificationURL, or completed when the credential was stored while starting the session, as for an OAuth connection that uses client credentials.

Available options:
pending,
completed
verification_url
string

VerificationURL is absent for a completed session.