Sitelet https://github.com/langchain-ai/agent-protocol/tree/main/client-python
Skip to content

Latest commit

 

History

History

README.md

ap-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.1.6
  • Package version: 1.0.0
  • Generator version: 7.13.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import ap_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ap_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ap_client
from ap_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ap_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with ap_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ap_client.AgentsApi(api_client)
    agent_id = 'agent_id_example' # str | The ID of the agent.

    try:
        # Get Agent
        api_response = api_instance.get_agent(agent_id)
        print("The response of AgentsApi->get_agent:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AgentsApi->get_agent: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AgentsApi get_agent GET /agents/{agent_id} Get Agent
AgentsApi get_agent_schemas GET /agents/{agent_id}/schemas Get Agent Schemas
AgentsApi search_agents POST /agents/search Search Agents
BackgroundRunsApi cancel_run POST /runs/{run_id}/cancel Cancel Run
BackgroundRunsApi create_run POST /runs Create Background Run
BackgroundRunsApi delete_run DELETE /runs/{run_id} Delete Run
BackgroundRunsApi get_run GET /runs/{run_id} Get Run
BackgroundRunsApi search_runs POST /runs/search Search Runs
BackgroundRunsApi stream_run GET /runs/{run_id}/stream Stream output from Run
BackgroundRunsApi wait_run GET /runs/{run_id}/wait Wait for Run output
RunsApi create_and_stream_run POST /runs/stream Create Run, Stream Output
RunsApi create_and_wait_run POST /runs/wait Create Run, Wait for Output
StoreApi delete_item DELETE /store/items Delete Store Item
StoreApi get_item GET /store/items Get Store Item
StoreApi list_namespaces POST /store/namespaces List namespaces
StoreApi put_item PUT /store/items Insert or Update Item
StoreApi search_items POST /store/items/search Search Store Items
ThreadsApi copy_thread POST /threads/{thread_id}/copy Copy Thread
ThreadsApi create_thread POST /threads Create Thread
ThreadsApi delete_thread DELETE /threads/{thread_id} Delete Thread
ThreadsApi get_thread GET /threads/{thread_id} Get Thread
ThreadsApi get_thread_history GET /threads/{thread_id}/history Get Thread History
ThreadsApi patch_thread PATCH /threads/{thread_id} Patch Thread
ThreadsApi search_threads POST /threads/search Search Threads

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author