Skip to content

chore: update API key docs for new orgs-scoped service keys - #584

Merged
Brian Vander Schaaf (bvs-langchain) merged 4 commits into
mainfrom
brian/ent-114-update-api-keys-docs
Sep 19, 2025
Merged

chore: update API key docs for new orgs-scoped service keys#584
Brian Vander Schaaf (bvs-langchain) merged 4 commits into
mainfrom
brian/ent-114-update-api-keys-docs

Conversation

@bvs-langchain

@bvs-langchain Brian Vander Schaaf (bvs-langchain) commented Sep 18, 2025

Copy link
Copy Markdown
Contributor

Overview

  • update usage instructions to account for new organization-scoped API keys:
    Org-Scoped-API-2

Type of change

Type: Update existing documentation

Related issues/PRs

  • GitHub issue:
  • Feature PR:
  • Linear issue: ent-114
  • Slack thread:

Checklist

  • I have read the contributing guidelines
  • I have tested my changes locally using docs dev
  • All code examples have been tested and work correctly
  • I have used root relative paths for internal links
  • I have updated navigation in src/docs.json if needed
  • I have gotten approval from the relevant reviewers
  • (Internal team members only / optional) I have created a preview deployment using the Create Preview Branch workflow

Additional notes

Copilot AI review requested due to automatic review settings September 18, 2025 18:57
@github-actions github-actions Bot added the langsmith For docs changes to LangSmith label Sep 18, 2025

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates LangSmith documentation to reflect the introduction of organization-scoped service keys, expanding beyond the previous workspace-only scope. The changes clarify usage instructions, API behavior, and authentication patterns for the new organization-level API keys.

Key Changes

  • Updated service key documentation to indicate support for organization-scoped keys with Organization Admin permissions
  • Clarified API behavior when using organization-scoped keys without workspace headers
  • Enhanced API key usage instructions and added cross-references

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
src/langsmith/manage-organization-by-api.mdx Updated limitations note, API endpoint links, and clarified header requirements for organization-scoped keys
src/langsmith/create-account-api-key.mdx Added alt text to images, fixed EU endpoint URL, and added cross-reference to organization API management
src/langsmith/administration-overview.mdx Updated service key description to reflect new organization and multi-workspace scoping capabilities

Comment thread src/langsmith/administration-overview.mdx Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Preview ID generated: preview-briane-1758221873-fced4bc

Comment thread src/langsmith/manage-organization-by-api.mdx Outdated
Comment thread src/langsmith/administration-overview.mdx Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Preview ID generated: preview-briane-1758222303-e5504e9

Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
Copilot AI review requested due to automatic review settings September 19, 2025 12:25
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings September 19, 2025 12:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Comment thread src/langsmith/create-account-api-key.mdx
@github-actions

Copy link
Copy Markdown
Contributor

Preview ID generated: preview-briane-1758284819-82122af

@bvs-langchain
Brian Vander Schaaf (bvs-langchain) merged commit 7e440ba into main Sep 19, 2025
11 checks passed
@bvs-langchain
Brian Vander Schaaf (bvs-langchain) deleted the brian/ent-114-update-api-keys-docs branch September 19, 2025 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

langsmith For docs changes to LangSmith

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants