agentcat_api 1.0.0

No project description provided

agentcat-api

API for AgentCat application

The agentcat_api package is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 1.0.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

• urllib3 >= 2.1.0, < 3.0.0
• python-dateutil >= 2.8.2
• pydantic >= 2
• typing-extensions >= 4.7.1

Getting Started

In your own code, to use this library to connect and interact with agentcat-api, you can run the following:

import agentcat_api
from agentcat_api.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with agentcat_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = agentcat_api.EventsApi(api_client)
    publish_event_request = agentcat_api.PublishEventRequest() # PublishEventRequest |  (optional)

    try:
        # Publish analytics event
        api_response = api_instance.publish_event(publish_event_request=publish_event_request)
        print("The response of EventsApi->publish_event:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling EventsApi->publish_event: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8000

Class	Method	HTTP request	Description
EventsApi	publish_event	POST /v1/public/events/	Publish analytics event
NotificationsApi	unsubscribe_notification	POST /v1/public/notifications/unsubscribe	Disable an email notification type for the token's user

Documentation For Models

• Error
• EventAcceptedResponse
• PublishEventRequest
• QueryTimeout
• UnsubscribeRequestRequest
• ValidationErrorValue

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author