Skip to content

Add X-Tenant-Id header info in the API key section #694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 2, 2025
Merged

Add X-Tenant-Id header info in the API key section #694

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb81881
Add x-tenant-id header info in the API key section
romain-priour-lc Sep 30, 2025
4377e16
improve wording
romain-priour-lc Sep 30, 2025
3e44bc8
re-word
romain-priour-lc Sep 30, 2025
4132f0f
Review comment
romain-priour-lc Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/langsmith/administration-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,13 @@ Service keys are similar to PATs, but are used to authenticate requests to the L

Service keys are prefixed with `lsv2_sk_`

<Warning>
Use the `X-Tenant-Id` header to specify the target workspace.

- **When using PATs**: If this header is omitted, requests will run against the default workspace associated with the key.
- **When using organization-scoped service keys**: You must include the `X-Tenant-Id` header when accessing workspace-scoped resources. Without it, the request will fail with a `403 Forbidden` error.
</Warning>

<Note>
To see how to create a service key or Personal Access Token, see the [setup guide](/langsmith/create-account-api-key)
</Note>
Expand Down