Class LangGraphReference

Reference to a specific LangGraph.

Index

Methods

deleteThread getState invoke invokeAsync resume resumeAsync

Methods

deleteThread

deleteThread(threadId: string): Promise<void>
Deletes all checkpoints for the given thread on this graph. Idempotent — succeeds on a nonexistent thread. After deletion, getState(threadId) returns an empty state and any subsequent invoke/resume on the same threadId starts fresh with no prior history.
Parameters
- threadId: string
  The thread to delete.
Returns Promise<void>

getState

getState(threadId: string): Promise<GetLangGraphStateSuccessResult>
Returns the current state of a LangGraph thread.
Parameters
- threadId: string
Returns Promise<GetLangGraphStateSuccessResult>

invoke

invoke(options?: InvokeLangGraphOptions): Promise<InvokeLangGraphSuccessResult>
Starts a new LangGraph run and waits for the result.

For very long graphs where you don't want to hold a Promise, use invokeAsync() instead.
Parameters
- options: InvokeLangGraphOptions = {}
  Initial state, optional thread to run against, and optional timeout and context of the run.
Returns Promise<InvokeLangGraphSuccessResult>

invokeAsync

invokeAsync(options?: InvokeLangGraphOptions): Promise<string>
Starts a new LangGraph run without waiting for the result. Returns a jobId — pass it to squid.job().awaitJob(jobId) or getJob(jobId) to retrieve the result later.

Use this for graphs that may run longer than is comfortable to hold a Promise for.
Parameters
- options: InvokeLangGraphOptions = {}
  Initial state, optional thread to run against, and optional timeout and context of the run.
Returns Promise<string>

resume

resume(
    threadId: string,
    resumePayload: unknown,
    options?: ResumeLangGraphOptions,
): Promise<InvokeLangGraphSuccessResult>
Resumes an interrupted LangGraph thread and waits for the result. The thread must currently be in interrupted status.
Parameters
- threadId: string
  The thread to resume.
- resumePayload: unknown
  Value passed to the interrupt() call inside the graph.
- options: ResumeLangGraphOptions = {}
  Optional timeout and context of the resumed run.
Returns Promise<InvokeLangGraphSuccessResult>

resumeAsync

resumeAsync(
    threadId: string,
    resumePayload: unknown,
    options?: ResumeLangGraphOptions,
): Promise<string>
Resumes an interrupted LangGraph thread without waiting for the result. Returns a jobId — pass it to squid.job().awaitJob(jobId) or getJob(jobId) to retrieve the result later.
Parameters
- threadId: string
  The thread to resume.
- resumePayload: unknown
  Value passed to the interrupt() call inside the graph.
- options: ResumeLangGraphOptions = {}
  Optional timeout and context of the resumed run.
Returns Promise<string>