agent-protocol API reference
112 public APIs from agent-protocol (langchain-ai/agent-protocol) — 35 classes, 27 functions, 50 methods. Signatures extracted by static analysis of the actual source.
Repository: langchain-ai/agent-protocol
| Kind | Count |
|---|---|
| Classes | 35 |
| Functions | 27 |
| Methods | 50 |
API list
class
client-python.ap_client.api_client.ApiClientGeneric API client for OpenAPI client library builds.
class
client-python.ap_client.api_response.ApiResponseAPI response object
method
client-python.ap_client.configuration.Configuration.auth_settings() -> AuthSettingsGets Auth Settings dict for api client.
method
client-python.ap_client.configuration.Configuration.get_api_key_with_prefix(identifier:str, alias:Optional[str]=None) -> Optional[str]Gets API key (with prefix if set).
method
client-python.ap_client.configuration.Configuration.get_default() -> SelfReturn the default configuration.
method
client-python.ap_client.configuration.Configuration.get_default_copy() -> SelfDeprecated.
method
client-python.ap_client.configuration.Configuration.host() -> strReturn generated host.
method
client-python.ap_client.configuration.Configuration.logger_file() -> Optional[str]The logger file.
method
client-python.ap_client.configuration.Configuration.logger_format() -> strThe logger format.
method
client-python.ap_client.configuration.Configuration.set_default(default:Optional[Self]) -> NoneSet default instance of configuration.
class
client-python.ap_client.exceptions.ConflictExceptionException for HTTP 409 Conflict.
class
client-python.ap_client.exceptions.OpenApiExceptionThe base exception class for all OpenAPIExceptions
class
client-python.ap_client.exceptions.UnprocessableEntityExceptionException for HTTP 422 Unprocessable Entity.
class
client-python.ap_client.models.agent.AgentAgent
method
client-python.ap_client.models.agent.Agent.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of Agent from a dict
method
client-python.ap_client.models.agent.Agent.from_json(json_str:str) -> Optional[Self]Create an instance of Agent from a JSON string
method
client-python.ap_client.models.agent.Agent.to_dict() -> Dict[str, Any]Return the dictionary representation of the model using alias.
class
client-python.ap_client.models.agent_schema.AgentSchemaDefines the structure and properties of an agent.
method
client-python.ap_client.models.agent_schema.AgentSchema.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of AgentSchema from a dict
method
client-python.ap_client.models.agent_schema.AgentSchema.from_json(json_str:str) -> Optional[Self]Create an instance of AgentSchema from a JSON string
class
client-python.ap_client.models.agent_schemas.AgentSchemasDefines the structure and properties of an agent.
method
client-python.ap_client.models.agent_schemas.AgentSchemas.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of AgentSchemas from a dict
class
client-python.ap_client.models.config.ConfigThe configuration for the agent.
method
client-python.ap_client.models.config.Config.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of Config from a dict
method
client-python.ap_client.models.config.Config.from_json(json_str:str) -> Optional[Self]Create an instance of Config from a JSON string
class
client-python.ap_client.models.content.ContentThe content of the message.
method
client-python.ap_client.models.content.Content.from_json(json_str:str) -> SelfReturns the object represented by the json string
class
client-python.ap_client.models.content_one_of_inner.ContentOneOfInnerContentOneOfInner
method
client-python.ap_client.models.content_one_of_inner.ContentOneOfInner.from_json(json_str:str) -> SelfReturns the object represented by the json string
class
client-python.ap_client.models.error_response.ErrorResponseErrorResponse
method
client-python.ap_client.models.error_response.ErrorResponse.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of ErrorResponse from a dict
class
client-python.ap_client.models.input.InputThe input to the agent.
method
client-python.ap_client.models.input.Input.from_json(json_str:str) -> SelfReturns the object represented by the json string
method
client-python.ap_client.models.item.Item.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of Item from a dict
method
client-python.ap_client.models.item.Item.from_json(json_str:str) -> Optional[Self]Create an instance of Item from a JSON string
class
client-python.ap_client.models.message.MessageMessage
method
client-python.ap_client.models.message.Message.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of Message from a dict
method
client-python.ap_client.models.message.Message.from_json(json_str:str) -> Optional[Self]Create an instance of Message from a JSON string
class
client-python.ap_client.models.message_any_block.MessageAnyBlockMessageAnyBlock
class
client-python.ap_client.models.message_text_block.MessageTextBlockMessageTextBlock
class
client-python.ap_client.models.run.RunRun
method
client-python.ap_client.models.run.Run.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of Run from a dict
method
client-python.ap_client.models.run.Run.from_json(json_str:str) -> Optional[Self]Create an instance of Run from a JSON string
method
client-python.ap_client.models.run.Run.if_not_exists_validate_enum(value)Validates the enum
method
client-python.ap_client.models.run.Run.on_completion_validate_enum(value)Validates the enum
method
client-python.ap_client.models.run.Run.on_disconnect_validate_enum(value)Validates the enum
class
client-python.ap_client.models.run_create.RunCreatePayload for creating a run.
method
client-python.ap_client.models.run_create.RunCreate.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of RunCreate from a dict
method
client-python.ap_client.models.run_create.RunCreate.from_json(json_str:str) -> Optional[Self]Create an instance of RunCreate from a JSON string
method
client-python.ap_client.models.run_create.RunCreate.if_not_exists_validate_enum(value)Validates the enum
method
client-python.ap_client.models.run_create.RunCreate.on_completion_validate_enum(value)Validates the enum
method
client-python.ap_client.models.run_create.RunCreate.on_disconnect_validate_enum(value)Validates the enum
class
client-python.ap_client.models.run_search_request.RunSearchRequestPayload for listing runs.
class
client-python.ap_client.models.run_status.RunStatusThe status of the run.
method
client-python.ap_client.models.run_status.RunStatus.from_json(json_str:str) -> SelfCreate an instance of RunStatus from a JSON string
class
client-python.ap_client.models.run_stream.RunStreamRunStream
method
client-python.ap_client.models.run_stream.RunStream.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of RunStream from a dict
method
client-python.ap_client.models.run_stream.RunStream.from_json(json_str:str) -> Optional[Self]Create an instance of RunStream from a JSON string
method
client-python.ap_client.models.run_stream.RunStream.if_not_exists_validate_enum(value)Validates the enum
method
client-python.ap_client.models.run_stream.RunStream.on_completion_validate_enum(value)Validates the enum
method
client-python.ap_client.models.run_stream.RunStream.on_disconnect_validate_enum(value)Validates the enum
class
client-python.ap_client.models.run_wait_response.RunWaitResponseRunWaitResponse
class
client-python.ap_client.models.search_agents_request.SearchAgentsRequestSearchAgentsRequest
class
client-python.ap_client.models.search_items_response.SearchItemsResponseSearchItemsResponse
class
client-python.ap_client.models.store_delete_request.StoreDeleteRequestRequest to delete an item.
class
client-python.ap_client.models.store_list_namespaces_request.StoreListNamespacesRequestStoreListNamespacesRequest
class
client-python.ap_client.models.store_put_request.StorePutRequestRequest to store or update an item.
class
client-python.ap_client.models.store_search_request.StoreSearchRequestRequest to search for items
class
client-python.ap_client.models.stream_mode.StreamModeThe stream mode(s) to use.
method
client-python.ap_client.models.stream_mode.StreamMode.from_json(json_str:str) -> SelfReturns the object represented by the json string
class
client-python.ap_client.models.thread.ThreadThread
method
client-python.ap_client.models.thread.Thread.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of Thread from a dict
method
client-python.ap_client.models.thread.Thread.from_json(json_str:str) -> Optional[Self]Create an instance of Thread from a JSON string
class
client-python.ap_client.models.thread_create.ThreadCreatePayload for creating a thread.
method
client-python.ap_client.models.thread_create.ThreadCreate.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of ThreadCreate from a dict
method
client-python.ap_client.models.thread_create.ThreadCreate.if_exists_validate_enum(value)Validates the enum
class
client-python.ap_client.models.thread_patch.ThreadPatchPayload for updating a thread.
method
client-python.ap_client.models.thread_patch.ThreadPatch.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of ThreadPatch from a dict
method
client-python.ap_client.models.thread_patch.ThreadPatch.from_json(json_str:str) -> Optional[Self]Create an instance of ThreadPatch from a JSON string
class
client-python.ap_client.models.thread_search_request.ThreadSearchRequestPayload for listing threads.
class
client-python.ap_client.models.thread_state.ThreadStateThreadState
method
client-python.ap_client.models.thread_state.ThreadState.from_dict(obj:Optional[Dict[str, Any]]) -> Optional[Self]Create an instance of ThreadState from a dict
method
client-python.ap_client.models.thread_state.ThreadState.from_json(json_str:str) -> Optional[Self]Create an instance of ThreadState from a JSON string
class
client-python.ap_client.models.thread_status.ThreadStatusThe status of the thread.
method
client-python.ap_client.models.thread_status.ThreadStatus.from_json(json_str:str) -> SelfCreate an instance of ThreadStatus from a JSON string
func
server.ap_server.routers.agents.get_agent(agent_id:str) -> Union[Agent, ErrorResponse]Get Agent
func
server.ap_server.routers.agents.get_agent_schemas(agent_id:str) -> Union[AgentSchema, ErrorResponse]Get Agent Schemas
func
server.ap_server.routers.agents.search_agents(body:AgentsSearchPostRequest) -> Union[AgentsSearchPostResponse, ErrorResponse]Search Agents
func
server.ap_server.routers.background_runs.cancel_run(run_id:UUID, wait:Optional[bool]=False, action:Optional[Action]='interrupt') -> Optional[ErrorResponse]Cancel Run
func
server.ap_server.routers.background_runs.create_run(body:RunStream) -> Union[Run, ErrorResponse]Create Background Run
func
server.ap_server.routers.background_runs.delete_run(run_id:UUID) -> Optional[ErrorResponse]Delete Run
func
server.ap_server.routers.background_runs.get_run(run_id:UUID) -> Union[Run, ErrorResponse]Get Run
func
server.ap_server.routers.background_runs.search_runs(body:RunSearchRequest) -> Union[RunsSearchPostResponse, ErrorResponse]Search Runs
func
server.ap_server.routers.background_runs.stream_run(run_id:UUID) -> Union[Any, ErrorResponse]Stream output from Run
func
server.ap_server.routers.background_runs.wait_run(run_id:UUID) -> Union[RunWaitResponse, ErrorResponse]Wait for Run output
func
server.ap_server.routers.runs.create_and_stream_run(body:RunStream) -> Union[str, ErrorResponse]Create Run, Stream Output
func
server.ap_server.routers.runs.create_and_wait_run(body:RunCreate) -> Union[RunWaitResponse, ErrorResponse]Create Run, Wait for Output
func
server.ap_server.routers.stateless_runs.run_stateless_runs_post(body:RunCreate) -> Union[Any, ErrorResponse]Create Background Run
func
server.ap_server.routers.stateless_runs.stream_run_stateless_runs_stream_post(body:RunCreate) -> Union[str, ErrorResponse]Create Run, Stream Output
func
server.ap_server.routers.stateless_runs.wait_run_stateless_runs_wait_post(body:RunCreate) -> Union[RunWaitResponse, ErrorResponse]Create Run, Wait for Output
func
server.ap_server.routers.store.delete_item(body:StoreDeleteRequest) -> Optional[ErrorResponse]Delete Store Item
func
server.ap_server.routers.store.get_item(key:str, namespace:Annotated[list[str] | None, Query()]=None) -> Union[Item, ErrorResponse]Get Store Item
func
server.ap_server.routers.store.list_namespaces(body:StoreListNamespacesRequest) -> Union[ListNamespaceResponse, ErrorResponse]List namespaces
func
server.ap_server.routers.store.put_item(body:StorePutRequest) -> Optional[ErrorResponse]Insert or Update Item
func
server.ap_server.routers.store.search_items(body:StoreSearchRequest) -> Union[SearchItemsResponse, ErrorResponse]Search Store Items
func
server.ap_server.routers.threads.copy_thread(thread_id:UUID) -> Union[Thread, ErrorResponse]Copy Thread
func
server.ap_server.routers.threads.create_thread(body:ThreadCreate) -> Union[Thread, ErrorResponse]Create Thread
func
server.ap_server.routers.threads.delete_thread(thread_id:UUID) -> Optional[ErrorResponse]Delete Thread
func
server.ap_server.routers.threads.get_thread(thread_id:UUID) -> Union[Thread, ErrorResponse]Get Thread
func
server.ap_server.routers.threads.get_thread_history(thread_id:UUID, limit:Optional[int]=10, before:Optional[str]=None) -> Union[ThreadsThreadIdHistoryGetResponse, ErrorResponse]Get Thread History
func
server.ap_server.routers.threads.patch_thread(thread_id:UUID, body:ThreadPatch=...) -> Union[Thread, ErrorResponse]Patch Thread
func
server.ap_server.routers.threads.search_threads(body:ThreadSearchRequest) -> Union[ThreadsSearchPostResponse, ErrorResponse]Search Threads
About this data
These signatures were extracted from the public source of langchain-ai/agent-protocol
using Python's ast module. Argument names, default values,
type annotations and return types are taken verbatim from the code.
Implementation bodies are never stored. See
how it works for details.