langgraph の API リファレンス
langgraph (langchain-ai/langgraph) の公開 API 321 件 —— クラス 163、関数 56、メソッド 102。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: langchain-ai/langgraph
| 種別 | 件数 |
|---|---|
| クラス | 163 |
| 関数 | 56 |
| メソッド | 102 |
API 一覧
class
libs.checkpoint-conformance.langgraph.checkpoint.conformance.report.CapabilityReportAggregate report across all capabilities.
method
libs.checkpoint-conformance.langgraph.checkpoint.conformance.report.CapabilityReport.print_report() -> NonePretty-print the report to stdout.
method
libs.checkpoint-conformance.langgraph.checkpoint.conformance.report.CapabilityReport.to_dict() -> dict[str, Any]Return a JSON-serializable dict.
class
libs.checkpoint-sqlite.langgraph.cache.sqlite.SqliteCacheFile-based cache using SQLite.
method
libs.checkpoint-sqlite.langgraph.cache.sqlite.SqliteCache.clear(namespaces:Sequence[Namespace] | None=None) -> NoneDelete the cached values for the given namespaces.
method
libs.checkpoint-sqlite.langgraph.cache.sqlite.SqliteCache.get(keys:Sequence[FullKey]) -> dict[FullKey, ValueT]Get the cached values for the given keys.
method
libs.checkpoint-sqlite.langgraph.cache.sqlite.SqliteCache.set(mapping:Mapping[FullKey, tuple[ValueT, int | None]]) -> NoneSet the cached values for the given keys and TTLs.
class
libs.checkpoint-sqlite.langgraph.store.sqlite.base.BaseSqliteStoreShared base class for SQLite stores.
class
libs.checkpoint.langgraph.cache.base.BaseCacheBase class for a cache.
method
libs.checkpoint.langgraph.cache.base.BaseCache.clear(namespaces:Sequence[Namespace] | None=None) -> NoneDelete the cached values for the given namespaces.
method
libs.checkpoint.langgraph.cache.base.BaseCache.get(keys:Sequence[FullKey]) -> dict[FullKey, ValueT]Get the cached values for the given keys.
method
libs.checkpoint.langgraph.cache.base.BaseCache.set(pairs:Mapping[FullKey, tuple[ValueT, int | None]]) -> NoneSet the cached values for the given keys and TTLs.
method
libs.checkpoint.langgraph.cache.memory.InMemoryCache.clear(namespaces:Sequence[Namespace] | None=None) -> NoneDelete the cached values for the given namespaces.
method
libs.checkpoint.langgraph.cache.memory.InMemoryCache.get(keys:Sequence[FullKey]) -> dict[FullKey, ValueT]Get the cached values for the given keys.
method
libs.checkpoint.langgraph.cache.memory.InMemoryCache.set(keys:Mapping[FullKey, tuple[ValueT, int | None]]) -> NoneSet the cached values for the given keys.
class
libs.checkpoint.langgraph.cache.redis.RedisCacheRedis-based cache implementation with TTL support.
method
libs.checkpoint.langgraph.cache.redis.RedisCache.clear(namespaces:Sequence[Namespace] | None=None) -> NoneDelete the cached values for the given namespaces.
method
libs.checkpoint.langgraph.cache.redis.RedisCache.get(keys:Sequence[FullKey]) -> dict[FullKey, ValueT]Get the cached values for the given keys.
method
libs.checkpoint.langgraph.cache.redis.RedisCache.set(mapping:Mapping[FullKey, tuple[ValueT, int | None]]) -> NoneSet the cached values for the given keys and TTLs.
class
libs.checkpoint.langgraph.checkpoint.base.BaseCheckpointSaverBase class for creating a graph checkpointer.
method
libs.checkpoint.langgraph.checkpoint.base.BaseCheckpointSaver.get(config:RunnableConfig) -> Checkpoint | NoneFetch a checkpoint using the given configuration.
method
libs.checkpoint.langgraph.checkpoint.base.BaseCheckpointSaver.get_next_version(current:V | None, channel:None) -> VGenerate the next version ID for a channel.
method
libs.checkpoint.langgraph.checkpoint.base.BaseCheckpointSaver.get_tuple(config:RunnableConfig) -> CheckpointTuple | NoneFetch a checkpoint tuple using the given configuration.
method
libs.checkpoint.langgraph.checkpoint.base.BaseCheckpointSaver.prune(thread_ids:Sequence[str], *strategy:str='keep_latest') -> NonePrune checkpoints for the given threads.
class
libs.checkpoint.langgraph.checkpoint.base.CheckpointState snapshot at a given point in time.
class
libs.checkpoint.langgraph.checkpoint.base.CheckpointMetadataMetadata associated with a checkpoint.
func
libs.checkpoint.langgraph.checkpoint.base.get_checkpoint_id(config:RunnableConfig) -> str | NoneGet checkpoint ID.
class
libs.checkpoint.langgraph.checkpoint.base.id.UUIDUUID draft version objects
class
libs.checkpoint.langgraph.checkpoint.memory.InMemorySaverAn in-memory checkpoint saver.
method
libs.checkpoint.langgraph.checkpoint.memory.InMemorySaver.aget_tuple(config:RunnableConfig) -> CheckpointTuple | NoneAsynchronous version of `get_tuple`.
method
libs.checkpoint.langgraph.checkpoint.memory.InMemorySaver.aput(config:RunnableConfig, checkpoint:Checkpoint, metadata:CheckpointMetadata, new_versions:ChannelVersions) -> RunnableConfigAsynchronous version of `put`.
method
libs.checkpoint.langgraph.checkpoint.memory.InMemorySaver.aput_writes(config:RunnableConfig, writes:Sequence[tuple[str, Any]], task_id:str, task_path:str='') -> NoneAsynchronous version of `put_writes`.
method
libs.checkpoint.langgraph.checkpoint.memory.InMemorySaver.get_tuple(config:RunnableConfig) -> CheckpointTuple | NoneGet a checkpoint tuple from the in-memory storage.
class
libs.checkpoint.langgraph.checkpoint.serde.base.CipherProtocolProtocol for encryption and decryption of data.
method
libs.checkpoint.langgraph.checkpoint.serde.base.CipherProtocol.decrypt(ciphername:str, ciphertext:bytes) -> bytesDecrypt ciphertext.
method
libs.checkpoint.langgraph.checkpoint.serde.base.CipherProtocol.encrypt(plaintext:bytes) -> tuple[str, bytes]Encrypt plaintext.
func
libs.checkpoint.langgraph.checkpoint.serde.event_hooks.emit_serde_event(event:SerdeEvent) -> NoneEmit a serde event to all listeners.
class
libs.checkpoint.langgraph.store.base.BaseStoreAbstract base class for persistent key-value stores.
method
libs.checkpoint.langgraph.store.base.BaseStore.abatch(ops:Iterable[Op]) -> list[Result]Execute multiple operations asynchronously in a single batch.
method
libs.checkpoint.langgraph.store.base.BaseStore.adelete(namespace:tuple[str, ...], key:str) -> NoneAsynchronously delete an item.
method
libs.checkpoint.langgraph.store.base.BaseStore.aget(namespace:tuple[str, ...], key:str, *refresh_ttl:bool | None=None) -> Item | NoneAsynchronously retrieve a single item.
method
libs.checkpoint.langgraph.store.base.BaseStore.batch(ops:Iterable[Op]) -> list[Result]Execute multiple operations synchronously in a single batch.
method
libs.checkpoint.langgraph.store.base.BaseStore.delete(namespace:tuple[str, ...], key:str) -> NoneDelete an item.
method
libs.checkpoint.langgraph.store.base.BaseStore.get(namespace:tuple[str, ...], key:str, *refresh_ttl:bool | None=None) -> Item | NoneRetrieve a single item.
class
libs.checkpoint.langgraph.store.base.InvalidNamespaceErrorProvided namespace is invalid.
class
libs.checkpoint.langgraph.store.base.ItemRepresents a stored item with metadata.
class
libs.checkpoint.langgraph.store.base.ListNamespacesOpOperation to list and filter namespaces in the store.
class
libs.checkpoint.langgraph.store.base.NotProvidedSentinel singleton.
class
libs.checkpoint.langgraph.store.base.PutOpOperation to store, update, or delete an item in the store.
func
libs.checkpoint.langgraph.store.base.embed.tokenize_path(path:str) -> list[str]Tokenize a path into components.
func
libs.cli.langgraph_cli.cli.new(path:str | None, template:str | None) -> NoneCreate a new LangGraph project from a template.
func
libs.cli.langgraph_cli.config.validate_config(config:Config) -> ConfigValidate a configuration dictionary.
func
libs.cli.langgraph_cli.config.validate_config_file(config_path:pathlib.Path) -> ConfigLoad and validate a configuration file.
func
libs.cli.langgraph_cli.deploy.format_log_entry(entry:dict) -> strFormat a single log entry for display.
func
libs.cli.langgraph_cli.deploy.level_fg(level:str) -> str | NoneReturn click color for a log level.
func
libs.cli.langgraph_cli.deploy.normalize_image_tag(value:str) -> strValidate and return a Docker image tag.
func
libs.cli.langgraph_cli.deploy.validate_deployment_selector(deployment_id:str | None, name:str | None) -> NoneEnsure either deployment_id or name is provided.
func
libs.cli.langgraph_cli.docker.dict_to_yaml(d:dict, *indent:int=0) -> strConvert a dictionary to a YAML string.
class
libs.cli.langgraph_cli.schemas.EncryptionConfigConfiguration for custom at-rest encryption logic.
class
libs.cli.langgraph_cli.schemas.GraphDefDefinition of a graph with additional metadata.
class
libs.cli.langgraph_cli.schemas.StoreConfigConfiguration for the built-in long-term memory store.
class
libs.cli.langgraph_cli.schemas.UvSourceDeployment source rooted at a uv project or workspace.
func
libs.cli.langgraph_cli.util.warn_non_wolfi_distro(config_json:dict, *emit:Callable[[str], None] | None=None) -> NoneShow warning if image_distro is not set to 'wolfi'.
func
libs.cli.python-monorepo-example.apps.agent.src.agent.graph.call_model(state:State) -> dictSimple node that uses the shared libraries.
class
libs.cli.python-monorepo-example.apps.agent.src.agent.state.StateThe state of the agent.
func
libs.cli.python-monorepo-example.libs.common.helpers.get_common_prefix() -> strGet a common prefix for messages.
func
libs.cli.python-monorepo-example.libs.shared.src.shared.utils.get_dummy_message() -> strGet a dummy message for testing.
func
libs.langgraph.bench.__main__.arun_first_event_latency(graph:Pregel, input:dict) -> NoneLatency for the first event.
func
libs.langgraph.bench.__main__.compile_graph(graph:StateGraph) -> NoneCompile the graph.
func
libs.langgraph.bench.__main__.run_first_event_latency(graph:Pregel, input:dict) -> NoneLatency for the first event.
func
libs.langgraph.bench.sequential.anoop(state:MessagesState) -> NoneNo-op function.
func
libs.langgraph.bench.sequential.noop(state:MessagesState) -> NoneNo-op function.
func
libs.langgraph.langgraph._internal._config.get_callback_manager_for_config(config:RunnableConfig, tags:Sequence[str] | None=None) -> CallbackManagerGet a callback manager for a config.
func
libs.langgraph.langgraph._internal._config.merge_configs(*configs:RunnableConfig | None) -> RunnableConfigMerge multiple configs into one.
func
libs.langgraph.langgraph._internal._config.recast_checkpoint_ns(ns:str) -> strRemove task IDs from checkpoint namespace.
func
libs.langgraph.langgraph._internal._fields.get_cached_annotated_keys(obj:type[Any]) -> tuple[str, ...]Return cached annotated keys for a Python class.
class
libs.langgraph.langgraph._internal._queue.AsyncQueueAsync unbounded FIFO queue with a wait() method.
method
libs.langgraph.langgraph._internal._queue.AsyncQueue.wait() -> NoneIf queue is empty, wait until an item is available.
class
libs.langgraph.langgraph._internal._queue.SemaphoreSemaphore subclass with a wait() method.
class
libs.langgraph.langgraph._internal._queue.SyncQueueUnbounded FIFO queue with a wait() method.
class
libs.langgraph.langgraph._internal._runnable.StrEnumA string enum.
func
libs.langgraph.langgraph._internal._runnable.coerce_to_runnable(thing:RunnableLike, *name:str | None, *trace:bool) -> RunnableCoerce a runnable-like object into a Runnable.
func
libs.langgraph.langgraph._internal._runnable.is_async_callable(func:Any) -> TypeGuard[Callable[..., Awaitable]]Check if a function is async.
func
libs.langgraph.langgraph._internal._runnable.is_async_generator(func:Any) -> TypeGuard[Callable[..., AsyncIterator]]Check if a function is an async generator.
class
libs.langgraph.langgraph.callbacks.GraphCallbackHandlerBase class for graph-level lifecycle callbacks.
method
libs.langgraph.langgraph.channels.any_value.AnyValue.ValueType() -> type[Value]The type of the value stored in the channel.
method
libs.langgraph.langgraph.channels.any_value.AnyValue.copy() -> SelfReturn a copy of the channel.
class
libs.langgraph.langgraph.channels.base.BaseChannelBase class for all channels.
method
libs.langgraph.langgraph.channels.base.BaseChannel.UpdateType() -> AnyThe type of the update received by the channel.
method
libs.langgraph.langgraph.channels.base.BaseChannel.ValueType() -> AnyThe type of the value stored in the channel.
method
libs.langgraph.langgraph.channels.base.BaseChannel.consume() -> boolNotify the channel that a subscribed task ran.
method
libs.langgraph.langgraph.channels.base.BaseChannel.copy() -> SelfReturn a copy of the channel.
method
libs.langgraph.langgraph.channels.base.BaseChannel.get() -> ValueReturn the current value of the channel.
class
libs.langgraph.langgraph.channels.topic.TopicA configurable PubSub Topic.
method
libs.langgraph.langgraph.channels.topic.Topic.UpdateType() -> AnyThe type of the update received by the channel.
method
libs.langgraph.langgraph.channels.topic.Topic.ValueType() -> AnyThe type of the value stored in the channel.
method
libs.langgraph.langgraph.channels.topic.Topic.copy() -> SelfReturn a copy of the channel.
class
libs.langgraph.langgraph.errors.EmptyInputErrorRaised when graph receives an empty input.
class
libs.langgraph.langgraph.errors.NodeErrorFailure context passed to a node-level error handler.
class
libs.langgraph.langgraph.errors.NodeInterruptRaised by a node to interrupt execution.
class
libs.langgraph.langgraph.func.entrypoint.finalA primitive that can be returned from an entrypoint.
class
libs.langgraph.langgraph.graph.ui.UIMessageA message type for UI updates in LangGraph.
func
libs.langgraph.langgraph.graph.ui.delete_ui_message(id:str, *state_key:str='ui') -> RemoveUIMessageDelete a UI message by ID from the UI state.
func
libs.langgraph.langgraph.pregel._algo.checkpoint_null_version(checkpoint:Checkpoint) -> V | NoneGet the null version for the checkpoint, if available.
func
libs.langgraph.langgraph.pregel._algo.task_path_str(tup:str | int | tuple) -> strGenerate a string representation of the task path.
func
libs.langgraph.langgraph.pregel._call.identifier(obj:Any, name:str | None=None) -> str | NoneReturn the module and name of an object.
func
libs.langgraph.langgraph.pregel._checkpoint.exit_delta_task_id(step:int, task_id:str) -> strSynthetic task id for exit-mode DeltaChannel writes.
func
libs.langgraph.langgraph.pregel._draw.add_edge(graph:Graph, source:str, target:str, *data:Any | None=None, *conditional:bool=False) -> NoneAdd an edge to the graph.
class
libs.langgraph.langgraph.pregel._messages.StreamMessagesHandlerV2v2 variant of `StreamMessagesHandler`.
class
libs.langgraph.langgraph.pregel._read.PregelNodeA node in a Pregel graph.
method
libs.langgraph.langgraph.pregel._read.PregelNode.flat_writers() -> list[Runnable]Get writers with optimizations applied.
method
libs.langgraph.langgraph.pregel._read.PregelNode.input_cache_key() -> INPUT_CACHE_KEY_TYPEGet a cache key for the input to the node.
func
libs.langgraph.langgraph.pregel._retry.run_with_retry(task:PregelExecutableTask, retry_policy:Sequence[RetryPolicy] | None, configurable:dict[str, Any] | None=None) -> NoneRun a task with retries.
class
libs.langgraph.langgraph.pregel._utils.FunctionNonLocalsGet the nonlocal variables accessed of a function.
method
libs.langgraph.langgraph.pregel._utils.FunctionNonLocals.visit_AsyncFunctionDef(node:ast.AsyncFunctionDef) -> AnyVisit an async function definition.
method
libs.langgraph.langgraph.pregel._utils.FunctionNonLocals.visit_FunctionDef(node:ast.FunctionDef) -> AnyVisit a function definition.
method
libs.langgraph.langgraph.pregel._utils.FunctionNonLocals.visit_Lambda(node:ast.Lambda) -> AnyVisit a lambda function.
class
libs.langgraph.langgraph.pregel._utils.NonLocalsGet nonlocal variables accessed.
method
libs.langgraph.langgraph.pregel._utils.NonLocals.visit_Attribute(node:ast.Attribute) -> AnyVisit an attribute node.
method
libs.langgraph.langgraph.pregel._utils.NonLocals.visit_Name(node:ast.Name) -> AnyVisit a name node.
func
libs.langgraph.langgraph.pregel._utils.get_function_nonlocals(func:Callable) -> list[Any]Get the nonlocal variables accessed by a function.
func
libs.langgraph.langgraph.pregel.debug.get_bolded_text(text:str) -> strGet bolded text.
func
libs.langgraph.langgraph.pregel.debug.get_colored_text(text:str, color:str) -> strGet colored text.
func
libs.langgraph.langgraph.pregel.debug.map_debug_tasks(tasks:Iterable[PregelExecutableTask]) -> Iterator[TaskPayload]Produce "task" events for stream_mode=debug.
func
libs.langgraph.langgraph.pregel.debug.rm_pregel_keys(config:RunnableConfig | None) -> RunnableConfig | NoneRemove pregel-specific keys from the config.
class
libs.langgraph.langgraph.runtime.RunControlRun-scoped control surface for cooperative draining.
method
libs.langgraph.langgraph.runtime.Runtime.merge(other:Runtime[ContextT]) -> Runtime[ContextT]Merge two runtimes together.
class
libs.langgraph.langgraph.runtime.ServerInfoMetadata injected by LangGraph Server.
func
libs.langgraph.langgraph.runtime.get_runtime(context_schema:type[ContextT] | None=None) -> Runtime[ContextT]Get the runtime for the current graph run.
func
libs.langgraph.langgraph.stream._convert.convert_to_protocol_event(part:StreamPart) -> ProtocolEventConvert a v2 StreamPart to a ProtocolEvent.
class
libs.langgraph.langgraph.stream._types.StreamTransformerExtension point for custom stream projections.
method
libs.langgraph.langgraph.stream._types.StreamTransformer.afail(err:BaseException) -> NoneCalled when the run ends with an error (async lane).
method
libs.langgraph.langgraph.stream._types.StreamTransformer.afinalize() -> NoneCalled when the run ends normally (async lane).
method
libs.langgraph.langgraph.stream._types.StreamTransformer.aprocess(event:ProtocolEvent) -> boolHandle an event on the async lane.
method
libs.langgraph.langgraph.stream._types.StreamTransformer.fail(err:BaseException) -> NoneCalled when the run ends with an error (sync lane).
method
libs.langgraph.langgraph.stream._types.StreamTransformer.finalize() -> NoneCalled when the run ends normally (sync lane).
method
libs.langgraph.langgraph.stream._types.StreamTransformer.init() -> dict[str, Any]Return the projection dict.
method
libs.langgraph.langgraph.stream._types.StreamTransformer.process(event:ProtocolEvent) -> boolHandle an event on the sync lane.
class
libs.langgraph.langgraph.stream.run_stream.AsyncGraphRunStreamAsync run stream with caller-driven pumping.
method
libs.langgraph.langgraph.stream.run_stream.AsyncGraphRunStream.abort() -> NoneStop the run early.
class
libs.langgraph.langgraph.stream.run_stream.GraphRunStreamSync run stream with caller-driven pumping.
method
libs.langgraph.langgraph.stream.run_stream.GraphRunStream.abort() -> NoneStop the run early.
class
libs.langgraph.langgraph.stream.transformers.DebugTransformerCapture debug events as a drainable stream.
class
libs.langgraph.langgraph.stream.transformers.TasksTransformerCapture raw task events as a drainable stream.
class
libs.langgraph.langgraph.types.CacheKeyCache key for a task.
class
libs.langgraph.langgraph.types.CachePolicyConfiguration for caching nodes.
class
libs.langgraph.langgraph.types.CheckpointPayloadPayload for a checkpoint event.
class
libs.langgraph.langgraph.types.CheckpointStreamPartStream part emitted for `stream_mode="checkpoints"`.
class
libs.langgraph.langgraph.types.CheckpointTaskA task entry within a `CheckpointPayload`.
class
libs.langgraph.langgraph.types.CustomStreamPartStream part emitted for `stream_mode="custom"`.
class
libs.langgraph.langgraph.types.DebugStreamPartStream part emitted for `stream_mode="debug"`.
class
libs.langgraph.langgraph.types.InterruptInformation about an interrupt that occurred in a node.
class
libs.langgraph.langgraph.types.MessagesStreamPartStream part emitted for `stream_mode="messages"`.
class
libs.langgraph.langgraph.types.PregelTaskA Pregel task.
class
libs.langgraph.langgraph.types.RetryPolicyConfiguration for retrying nodes.
class
libs.langgraph.langgraph.types.TaskPayloadPayload for a task start event.
class
libs.langgraph.langgraph.types.TaskResultPayloadPayload for a task result event.
class
libs.langgraph.langgraph.types.TasksStreamPartStream part emitted for `stream_mode="tasks"`.
class
libs.langgraph.langgraph.types.TimeoutPolicyConfiguration for timing out node attempts.
class
libs.langgraph.langgraph.types.UpdatesStreamPartStream part emitted for `stream_mode="updates"`.
class
libs.langgraph.langgraph.types.ValuesStreamPartStream part emitted for `stream_mode="values"`.
func
libs.langgraph.langgraph.types.interrupt(value:Any) -> AnyInterrupt the graph with a resumable exception from within a node.
class
libs.langgraph.langgraph.warnings.LangGraphDeprecationWarningA LangGraph specific deprecation warning.
class
libs.prebuilt.langgraph.prebuilt._tool_call_stream.ToolCallStreamScoped view of a single tool call's lifecycle.
class
libs.prebuilt.langgraph.prebuilt.chat_agent_executor.AgentStateThe state of the agent.
class
libs.prebuilt.langgraph.prebuilt.chat_agent_executor.AgentStatePydanticThe state of the agent.
func
libs.prebuilt.langgraph.prebuilt.chat_agent_executor.post_model_hook_router(state:StateSchema) -> str | list[Send]Route to the next node after post_model_hook.
class
libs.prebuilt.langgraph.prebuilt.tool_node.ToolCallWithContextToolCall with additional context for graph state.
class
libs.prebuilt.langgraph.prebuilt.tool_node.ToolNodeA node for executing tools in LangGraph workflows.
func
libs.prebuilt.langgraph.prebuilt.tool_node.ToolNode.execute(req:ToolCallRequest) -> ToolMessage | CommandExecute tool with given request.
class
libs.prebuilt.langgraph.prebuilt.tool_node.ToolRuntimeRuntime context automatically injected into tools.
func
libs.prebuilt.langgraph.prebuilt.tool_node.msg_content_output(output:Any) -> str | list[dict]Convert tool output to `ToolMessage` content format.
class
libs.sdk-py.integration.graph.streaming_graph.AgentStateTop-level state for the agent.
func
libs.sdk-py.integration.graph.streaming_graph.ask_human(state:AgentState) -> dict[str, Any]Pause the graph and wait for a `thread.run.respond(...)`.
func
libs.sdk-py.integration.graph.streaming_graph.call_tool(state:AgentState) -> dict[str, Any]Invoke a tool and emit its result as a tool message.
func
libs.sdk-py.integration.graph.streaming_graph.search(query:str) -> strLook up `query` in a fake search index.
func
libs.sdk-py.integration.graph.streaming_graph.stream_message(state:AgentState) -> dict[str, Any]Stream an AI message via a fake chat model.
func
libs.sdk-py.integration.graph.tools_agent.search(query:str) -> strLook up `query` in a fake search index.
class
libs.sdk-py.langgraph_sdk._async.assistants.AssistantsClientClient for managing assistants in LangGraph.
method
libs.sdk-py.langgraph_sdk._async.assistants.AssistantsClient.delete(assistant_id:str, *delete_threads:bool=False, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> NoneDelete an assistant.
method
libs.sdk-py.langgraph_sdk._async.assistants.AssistantsClient.get(assistant_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> AssistantGet an assistant by ID.
class
libs.sdk-py.langgraph_sdk._async.client.LangGraphClientTop-level client for LangGraph API.
method
libs.sdk-py.langgraph_sdk._async.client.LangGraphClient.aclose() -> NoneClose the underlying HTTP client.
class
libs.sdk-py.langgraph_sdk._async.http.HttpClientHandle async requests to the LangGraph API.
method
libs.sdk-py.langgraph_sdk._async.http.HttpClient.delete(path:str, *json:Any | None=None, *params:QueryParamTypes | None=None, *headers:Mapping[str, str] | None=None, *on_response:Callable[[httpx.Response], None] | None=None) -> NoneSend a `DELETE` request.
method
libs.sdk-py.langgraph_sdk._async.http.HttpClient.get(path:str, *params:QueryParamTypes | None=None, *headers:Mapping[str, str] | None=None, *on_response:Callable[[httpx.Response], None] | None=None) -> AnySend a `GET` request.
method
libs.sdk-py.langgraph_sdk._async.http.HttpClient.patch(path:str, *json:dict, *params:QueryParamTypes | None=None, *headers:Mapping[str, str] | None=None, *on_response:Callable[[httpx.Response], None] | None=None) -> AnySend a `PATCH` request.
method
libs.sdk-py.langgraph_sdk._async.http.HttpClient.post(path:str, *json:dict[str, Any] | list | None, *params:QueryParamTypes | None=None, *headers:Mapping[str, str] | None=None, *on_response:Callable[[httpx.Response], None] | None=None) -> AnySend a `POST` request.
method
libs.sdk-py.langgraph_sdk._async.http.HttpClient.put(path:str, *json:dict, *params:QueryParamTypes | None=None, *headers:Mapping[str, str] | None=None, *on_response:Callable[[httpx.Response], None] | None=None) -> AnySend a `PUT` request.
class
libs.sdk-py.langgraph_sdk._async.runs.RunsClientClient for managing runs in LangGraph.
method
libs.sdk-py.langgraph_sdk._async.runs.RunsClient.cancel(thread_id:str, run_id:str, *wait:bool=False, *action:CancelAction='interrupt', *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> NoneGet a run.
method
libs.sdk-py.langgraph_sdk._async.runs.RunsClient.delete(thread_id:str, run_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> NoneDelete a run.
method
libs.sdk-py.langgraph_sdk._async.runs.RunsClient.get(thread_id:str, run_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> RunGet a run.
method
libs.sdk-py.langgraph_sdk._async.runs.RunsClient.join(thread_id:str, run_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> dictBlock until a run is done.
method
libs.sdk-py.langgraph_sdk._async.runs.RunsClient.list(thread_id:str, *limit:int=10, *offset:int=0, *status:RunStatus | None=None, *select:builtins.list[RunSelectField] | None=None, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> builtins.list[Run]List runs.
func
libs.sdk-py.langgraph_sdk._async.runs.RunsClient.on_response(res:httpx.Response)Callback function to handle the response.
method
libs.sdk-py.langgraph_sdk._async.store.StoreClient.delete_item(namespace:Sequence[str], key:str, headers:Mapping[str, str] | None=None, params:QueryParamTypes | None=None) -> NoneDelete an item.
method
libs.sdk-py.langgraph_sdk._async.store.StoreClient.get_item(namespace:Sequence[str], key:str, *refresh_ttl:bool | None=None, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> ItemRetrieve a single item.
class
libs.sdk-py.langgraph_sdk._async.stream.RunModuleCommand dispatcher for `run.start`.
method
libs.sdk-py.langgraph_sdk._async.stream.RunModule.start(*input:Any=None, *config:dict[str, Any] | None=None, *metadata:dict[str, Any] | None=None) -> dict[str, Any]Send `run.start` to the server.
class
libs.sdk-py.langgraph_sdk._async.stream.ToolCallHandleAsync handle for one root-scope tool call.
class
libs.sdk-py.langgraph_sdk._async.threads.ThreadsClientClient for managing threads in LangGraph.
method
libs.sdk-py.langgraph_sdk._async.threads.ThreadsClient.copy(thread_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> NoneCopy a thread.
method
libs.sdk-py.langgraph_sdk._async.threads.ThreadsClient.delete(thread_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> NoneDelete a thread.
method
libs.sdk-py.langgraph_sdk._async.threads.ThreadsClient.get(thread_id:str, *include:Sequence[str] | None=None, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> ThreadGet a thread by ID.
method
libs.sdk-py.langgraph_sdk._async.threads.ThreadsClient.prune(thread_ids:Sequence[str], *strategy:PruneStrategy='delete', *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> dict[str, Any]Prune threads by ID.
method
libs.sdk-py.langgraph_sdk._sync.cron.SyncCronClient.delete(cron_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> NoneDelete a cron.
class
libs.sdk-py.langgraph_sdk._sync.http.SyncHttpClientHandle synchronous requests to the LangGraph API.
method
libs.sdk-py.langgraph_sdk._sync.http.SyncHttpClient.get(path:str, *params:QueryParamTypes | None=None, *headers:Mapping[str, str] | None=None, *on_response:Callable[[httpx.Response], None] | None=None) -> AnySend a `GET` request.
method
libs.sdk-py.langgraph_sdk._sync.http.SyncHttpClient.patch(path:str, *json:dict, *params:QueryParamTypes | None=None, *headers:Mapping[str, str] | None=None, *on_response:Callable[[httpx.Response], None] | None=None) -> AnySend a `PATCH` request.
method
libs.sdk-py.langgraph_sdk._sync.http.SyncHttpClient.post(path:str, *json:dict[str, Any] | list | None, *params:QueryParamTypes | None=None, *headers:Mapping[str, str] | None=None, *on_response:Callable[[httpx.Response], None] | None=None) -> AnySend a `POST` request.
method
libs.sdk-py.langgraph_sdk._sync.http.SyncHttpClient.put(path:str, *json:dict, *params:QueryParamTypes | None=None, *headers:Mapping[str, str] | None=None, *on_response:Callable[[httpx.Response], None] | None=None) -> AnySend a `PUT` request.
class
libs.sdk-py.langgraph_sdk._sync.runs.SyncRunsClientSynchronous client for managing runs in LangGraph.
method
libs.sdk-py.langgraph_sdk._sync.runs.SyncRunsClient.cancel(thread_id:str, run_id:str, *wait:bool=False, *action:CancelAction='interrupt', *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> NoneGet a run.
method
libs.sdk-py.langgraph_sdk._sync.runs.SyncRunsClient.delete(thread_id:str, run_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> NoneDelete a run.
method
libs.sdk-py.langgraph_sdk._sync.runs.SyncRunsClient.get(thread_id:str, run_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> RunGet a run.
method
libs.sdk-py.langgraph_sdk._sync.runs.SyncRunsClient.join(thread_id:str, run_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> dictBlock until a run is done.
method
libs.sdk-py.langgraph_sdk._sync.runs.SyncRunsClient.list(thread_id:str, *limit:int=10, *offset:int=0, *status:RunStatus | None=None, *select:builtins.list[RunSelectField] | None=None, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> builtins.list[Run]List runs.
class
libs.sdk-py.langgraph_sdk._sync.stream.SyncRunModuleCommand dispatcher for `run.start`.
method
libs.sdk-py.langgraph_sdk._sync.stream.SyncRunModule.start(*input:Any=None, *config:dict[str, Any] | None=None, *metadata:dict[str, Any] | None=None) -> dict[str, Any]Send `run.start` to the server.
class
libs.sdk-py.langgraph_sdk._sync.stream.SyncToolCallHandleSync handle for one root-scope tool call.
method
libs.sdk-py.langgraph_sdk._sync.threads.SyncThreadsClient.copy(thread_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> NoneCopy a thread.
method
libs.sdk-py.langgraph_sdk._sync.threads.SyncThreadsClient.delete(thread_id:str, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> NoneDelete a thread.
method
libs.sdk-py.langgraph_sdk._sync.threads.SyncThreadsClient.get(thread_id:str, *include:Sequence[str] | None=None, *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> ThreadGet a thread by ID.
method
libs.sdk-py.langgraph_sdk._sync.threads.SyncThreadsClient.prune(thread_ids:Sequence[str], *strategy:PruneStrategy='delete', *headers:Mapping[str, str] | None=None, *params:QueryParamTypes | None=None) -> dict[str, Any]Prune threads by ID.
method
libs.sdk-py.langgraph_sdk.auth.Auth.authenticate(fn:AH) -> AHRegister an authentication handler function.
class
libs.sdk-py.langgraph_sdk.auth.types.AssistantsCreatePayload for creating an assistant.
class
libs.sdk-py.langgraph_sdk.auth.types.AssistantsDeletePayload for deleting an assistant.
class
libs.sdk-py.langgraph_sdk.auth.types.AssistantsReadPayload for reading an assistant.
class
libs.sdk-py.langgraph_sdk.auth.types.AssistantsSearchPayload for searching assistants.
class
libs.sdk-py.langgraph_sdk.auth.types.AssistantsUpdatePayload for updating an assistant.
class
libs.sdk-py.langgraph_sdk.auth.types.BaseAuthContextBase class for authentication context.
class
libs.sdk-py.langgraph_sdk.auth.types.BaseUserThe base ASGI user protocol
method
libs.sdk-py.langgraph_sdk.auth.types.BaseUser.display_name() -> strThe display name of the user.
method
libs.sdk-py.langgraph_sdk.auth.types.BaseUser.identity() -> strThe unique identifier for the user.
method
libs.sdk-py.langgraph_sdk.auth.types.BaseUser.is_authenticated() -> boolWhether the user is authenticated.
method
libs.sdk-py.langgraph_sdk.auth.types.BaseUser.permissions() -> Sequence[str]The permissions associated with the user.
class
libs.sdk-py.langgraph_sdk.auth.types.CronsCreatePayload for creating a cron job.
class
libs.sdk-py.langgraph_sdk.auth.types.CronsDeletePayload for deleting a cron job.
class
libs.sdk-py.langgraph_sdk.auth.types.CronsReadPayload for reading a cron job.
class
libs.sdk-py.langgraph_sdk.auth.types.CronsSearchPayload for searching cron jobs.
class
libs.sdk-py.langgraph_sdk.auth.types.CronsUpdatePayload for updating a cron job.
method
libs.sdk-py.langgraph_sdk.auth.types.MinimalUser.identity() -> strThe unique identifier for the user.
class
libs.sdk-py.langgraph_sdk.auth.types.MinimalUserDictThe dictionary representation of a user.
class
libs.sdk-py.langgraph_sdk.auth.types.RunsCreatePayload for creating a run.
class
libs.sdk-py.langgraph_sdk.auth.types.StoreDeleteOperation to delete an item from the store.
class
libs.sdk-py.langgraph_sdk.auth.types.ThreadTTLTime-to-live configuration for a thread.
class
libs.sdk-py.langgraph_sdk.auth.types.ThreadsCreateParameters for creating a new thread.
class
libs.sdk-py.langgraph_sdk.auth.types.ThreadsDeleteParameters for deleting a thread.
class
libs.sdk-py.langgraph_sdk.auth.types.ThreadsSearchParameters for searching threads.
class
libs.sdk-py.langgraph_sdk.auth.types.ThreadsUpdateParameters for updating a thread or run.
class
libs.sdk-py.langgraph_sdk.auth.types.on.assistantsTypes for assistant-related operations.
class
libs.sdk-py.langgraph_sdk.auth.types.on.assistants.createType for assistant creation parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.assistants.deleteType for assistant deletion parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.assistants.readType for assistant read parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.assistants.searchType for assistant search parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.assistants.updateType for assistant update parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.cronsTypes for cron-related operations.
class
libs.sdk-py.langgraph_sdk.auth.types.on.crons.createType for cron creation parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.crons.deleteType for cron deletion parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.crons.readType for cron read parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.crons.searchType for cron search parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.crons.updateType for cron update parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.storeTypes for store-related operations.
class
libs.sdk-py.langgraph_sdk.auth.types.on.store.deleteType for store delete parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.store.getType for store get parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.store.list_namespacesType for store list namespaces parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.store.putType for store put parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.store.searchType for store search parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.threadsTypes for thread-related operations.
class
libs.sdk-py.langgraph_sdk.auth.types.on.threads.createType for thread creation parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.threads.create_runType for creating or streaming a run.
class
libs.sdk-py.langgraph_sdk.auth.types.on.threads.deleteType for thread deletion parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.threads.readType for thread read parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.threads.searchType for thread search parameters.
class
libs.sdk-py.langgraph_sdk.auth.types.on.threads.updateType for thread update parameters.
class
libs.sdk-py.langgraph_sdk.cache.SWRResultResult wrapper returned by :func:`swr`.
method
libs.sdk-py.langgraph_sdk.cache.SWRResult.mutate(value:T=...) -> TUpdate or revalidate the cached value.
func
libs.sdk-py.langgraph_sdk.cache.cache_get(key:str) -> Any | NoneGet a value from the cache.
func
libs.sdk-py.langgraph_sdk.cache.cache_set(key:str, value:Any, *ttl:timedelta | None=None) -> NoneSet a value in the cache.
method
libs.sdk-py.langgraph_sdk.encryption.Encryption.get_json_decryptor(_model:str | None=None) -> types.JsonDecryptor | NoneGet the JSON decryptor.
method
libs.sdk-py.langgraph_sdk.encryption.Encryption.get_json_encryptor(_model:str | None=None) -> types.JsonEncryptor | NoneGet the JSON encryptor.
class
libs.sdk-py.langgraph_sdk.encryption.LangGraphBetaWarningWarning for beta features in LangGraph SDK.
class
libs.sdk-py.langgraph_sdk.encryption.types.EncryptionContextContext passed to encryption/decryption handlers.
class
libs.sdk-py.langgraph_sdk.schema.AssistantRepresents an assistant with additional properties.
class
libs.sdk-py.langgraph_sdk.schema.AssistantBaseBase model for an assistant.
class
libs.sdk-py.langgraph_sdk.schema.AssistantVersionRepresents a specific version of an assistant.
class
libs.sdk-py.langgraph_sdk.schema.AssistantsSearchResponsePaginated response for assistant search results.
class
libs.sdk-py.langgraph_sdk.schema.CheckpointRepresents a checkpoint in the execution process.
class
libs.sdk-py.langgraph_sdk.schema.CheckpointPayloadPayload for a checkpoint event.
class
libs.sdk-py.langgraph_sdk.schema.CheckpointTaskPayloadA task entry within a `CheckpointPayload`.
class
libs.sdk-py.langgraph_sdk.schema.ConfigConfiguration options for a call.
class
libs.sdk-py.langgraph_sdk.schema.CronRepresents a scheduled task.
class
libs.sdk-py.langgraph_sdk.schema.CronUpdatePayload for updating a cron job.
class
libs.sdk-py.langgraph_sdk.schema.CustomStreamPartStream part emitted for `stream_mode="custom"`.
class
libs.sdk-py.langgraph_sdk.schema.DebugStreamPartStream part emitted for `stream_mode="debug"`.
class
libs.sdk-py.langgraph_sdk.schema.GraphSchemaDefines the structure and properties of a graph.
class
libs.sdk-py.langgraph_sdk.schema.InterruptRepresents an interruption in the execution flow.
class
libs.sdk-py.langgraph_sdk.schema.LangSmithTracingConfiguration for LangSmith tracing.
class
libs.sdk-py.langgraph_sdk.schema.ListNamespaceResponseResponse structure for listing namespaces.
class
libs.sdk-py.langgraph_sdk.schema.MetadataStreamPartControl event with `run_id` and other run metadata.
class
libs.sdk-py.langgraph_sdk.schema.RunRepresents a single execution run.
class
libs.sdk-py.langgraph_sdk.schema.RunCreateDefines the parameters for initiating a background run.
class
libs.sdk-py.langgraph_sdk.schema.RunCreateMetadataMetadata for a run creation request.
class
libs.sdk-py.langgraph_sdk.schema.RunMetadataPayloadPayload for the `metadata` control event.
class
libs.sdk-py.langgraph_sdk.schema.SearchItemsResponseResponse structure for searching items.
class
libs.sdk-py.langgraph_sdk.schema.StreamPartRepresents a part of a stream response.
class
libs.sdk-py.langgraph_sdk.schema.TaskPayloadPayload for a task start event.
class
libs.sdk-py.langgraph_sdk.schema.TaskResultPayloadPayload for a task result event.
class
libs.sdk-py.langgraph_sdk.schema.TasksStreamPartStream part emitted for `stream_mode="tasks"`.
class
libs.sdk-py.langgraph_sdk.schema.ThreadRepresents a conversation thread.
class
libs.sdk-py.langgraph_sdk.schema.ThreadStateRepresents the state of a thread.
class
libs.sdk-py.langgraph_sdk.schema.ThreadTaskRepresents a task within a thread.
class
libs.sdk-py.langgraph_sdk.schema.UpdatesStreamPartStream part emitted for `stream_mode="updates"`.
class
libs.sdk-py.langgraph_sdk.schema.ValuesStreamPartStream part emitted for `stream_mode="values"`.
class
libs.sdk-py.langgraph_sdk.sse.BytesLineDecoderHandles incrementally reading lines from text.
func
libs.sdk-py.langgraph_sdk.stream.subscription.filter_covers(coverer:dict[str, Any], target:dict[str, Any]) -> boolWhether `coverer` is a superset of `target`.
func
libs.sdk-py.langgraph_sdk.stream.subscription.is_prefix_match(event_namespace:Namespace, prefix:Namespace) -> boolWhether `event_namespace` starts with `prefix`.
func
libs.sdk-py.langgraph_sdk.stream.subscription.normalize_segment(segment:str) -> strStrip the dynamic suffix after `:` from a namespace segment.
class
libs.sdk-py.langgraph_sdk.stream.transport.base.EventStreamHandleHandle for one async filtered event stream.
class
libs.sdk-py.langgraph_sdk.stream.transport.base.SyncEventStreamHandleHandle for one sync filtered event stream.
この情報について
掲載しているシグネチャは langchain-ai/langgraph の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。