API for application developers
This client is automatically generated from the OpenAPI specification. To regenerate the client:
# Pull the OpenAPI Generator Docker image (version 7.12.0 to match current) docker pull openapitools/openapi-generator-cli:v7.12.0 # Run the generator (from the repository root) docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:v7.12.0 generate \ -i /local/gen/openapi.yaml \ -g python \ -c /local/gen/config.json \ -o /local# Install via npm npm install -g @openapitools/openapi-generator-cli@7.12.0 # Set the version npx @openapitools/openapi-generator-cli version-manager set 7.12.0 # Generate the client npx @openapitools/openapi-generator-cli generate \ -i ./gen/openapi.yaml \ -g python \ -c ./gen/config.json \ -o .# Build the package uv build # Optionally publish the package uv publish- The OpenAPI spec at
./gen/openapi.yamlis the source of truth for this client - Update this spec file first if you need to update the API client
- The configuration in
./gen/config.jsonspecifies the package name as "codegen_api_client" - GitHub workflows handle testing and publishing, but not regeneration
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.12.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python 3.8+
If the python package is hosted on a repository, you can install directly using:
uv pip install codegen-api-clientThen import the package:
import codegen_api_clientExecute pytest to run the tests.
Please follow the installation procedure and then run the following:
import codegen_api_client from codegen_api_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 = codegen_api_client.Configuration( host = "http://localhost" ) # Enter a context with an instance of the API client with codegen_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = codegen_api_client.AgentsApi(api_client) org_id = 56 # int | create_agent_run_input = codegen_api_client.CreateAgentRunInput() # CreateAgentRunInput | authorization = None # object | (optional) try: # Create Agent Run api_response = api_instance.create_agent_run_v1_organizations_org_id_agent_run_post(org_id, create_agent_run_input, authorization=authorization) print("The response of AgentsApi->create_agent_run_v1_organizations_org_id_agent_run_post:\n") pprint(api_response) except ApiException as e: print("Exception when calling AgentsApi->create_agent_run_v1_organizations_org_id_agent_run_post: %s\n" % e)All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AgentsApi | create_agent_run_v1_organizations_org_id_agent_run_post | POST /v1/organizations/{org_id}/agent/run | Create Agent Run |
| AgentsApi | create_agent_run_v1_organizations_org_id_agent_run_post_0 | POST /v1/organizations/{org_id}/agent/run | Create Agent Run |
| AgentsApi | create_agent_run_v1_organizations_org_id_agent_run_post_1 | POST /v1/organizations/{org_id}/agent/run | Create Agent Run |
| AgentsApi | get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get | GET /v1/organizations/{org_id}/agent/run/{agent_run_id} | Get Agent Run |
| AgentsApi | get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_0 | GET /v1/organizations/{org_id}/agent/run/{agent_run_id} | Get Agent Run |
| AgentsApi | get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_1 | GET /v1/organizations/{org_id}/agent/run/{agent_run_id} | Get Agent Run |
| OrganizationsApi | get_organizations_v1_organizations_get | GET /v1/organizations | Get Organizations |
| OrganizationsApi | get_organizations_v1_organizations_get_0 | GET /v1/organizations | Get Organizations |
| OrganizationsApi | get_organizations_v1_organizations_get_1 | GET /v1/organizations | Get Organizations |
| UsersApi | get_user_v1_organizations_org_id_users_user_id_get | GET /v1/organizations/{org_id}/users/{user_id} | Get User |
| UsersApi | get_user_v1_organizations_org_id_users_user_id_get_0 | GET /v1/organizations/{org_id}/users/{user_id} | Get User |
| UsersApi | get_user_v1_organizations_org_id_users_user_id_get_1 | GET /v1/organizations/{org_id}/users/{user_id} | Get User |
| UsersApi | get_users_v1_organizations_org_id_users_get | GET /v1/organizations/{org_id}/users | Get Users |
| UsersApi | get_users_v1_organizations_org_id_users_get_0 | GET /v1/organizations/{org_id}/users | Get Users |
| UsersApi | get_users_v1_organizations_org_id_users_get_1 | GET /v1/organizations/{org_id}/users | Get Users |
- AgentRunResponse
- CreateAgentRunInput
- FastAPIRateLimitResponse
- HTTPValidationError
- OrganizationResponse
- OrganizationSettings
- PageOrganizationResponse
- PageUserResponse
- UserResponse
- ValidationError
- ValidationErrorLocInner
Endpoints do not require authorization.