Skip to main content
POST
Start entering the caller's credential for a secret MCP server

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.

Headers

X-LangSmith-Identity
string

Advanced alternative to a user OIDC token with a workspace API key. Set to the user's Tool Gateway identity UUID or provider:subject. Selecting another user requires workspaces:credentials:use or agent-auth-credentials:use. Ignored for personal credentials.

Path Parameters

id
string
required

Workspace server ID or built-in catalog key

Query Parameters

credential_owner_type
enum<string>

Owner whose credential to connect instead of the caller's. Requires a user credential; tool calls cannot name an owner.

Available options:
agent_identity
credential_owner_id
string<uuid>

Agent environment ID, from GET /api/v1/agents/{agent_id}. Sent with credential_owner_type.

Response

Created

A link where you enter an MCP server's credential, 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.