LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangSmith
  • Client
  • Run Trees
  • Traceable
  • Evaluation
  • Schemas
  • Langchain
  • Jest
  • Vitest
  • Wrappers
  • Anonymizer
  • Jestlike
  • Vercel
  • Anthropic
  • Sandbox
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangSmith
ClientRun TreesTraceableEvaluationSchemasLangchainJestVitestWrappersAnonymizerJestlikeVercelAnthropicSandbox
Language
Theme
JavaScriptlangsmith_openapi_clientresourcesthreadsShareretrieve
Method●Since v0.14

retrieve

Returns the share token for a thread. The token is omitted when the thread is not shared. Gated on runs:share so the control's state matches the control's permission.

Copy
retrieve(
  threadID: string,
  query: ShareRetrieveParams,
  options: RequestOptions
): APIPromise<ShareRetrieveResponse>

Parameters

NameTypeDescription
threadID*string
query*ShareRetrieveParams
optionsRequestOptions

Example

Copy
const share = await client.threads.share.retrieve(
  'thread_id',
  { project_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);
View source on GitHub