air-sdk-python 0.19.8

Python Client SDK Generated by Speakeasy

air-sdk-python

Summary

Air.ai API: Client API Documantation

Some useful links:

• Temporal

Table of Contents

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication

SDK Installation

The SDK can be installed using the pip package manager, with dependencies and metadata stored in the setup.py file.

pip install air-sdk-python

SDK Example Usage

Example

import air
from air.models import shared

s = air.Air(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.call.initiate_call(request=shared.Call(
    phone='874.397.6390 x76992',
    prompt_id=230621,
))

if res.object is not None:
    # handle response
    pass

Available Resources and Operations

Available methods

call

• initiate_call - Initiate a call

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will raise a errors.SDKError exception, which has the following properties:

Property	Type	Description
.status_code	int	The HTTP status code
.message	str	The error message
.raw_response	httpx.Response	The raw HTTP response
.body	str	The response content

When custom error responses are specified for an operation, the SDK may also raise their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the initiate_call method may raise the following exceptions:

Error Type	Status Code	Content Type
errors.InitiateCallResponseBody	401	application/json
errors.InitiateCallCallResponseBody	403	application/json
errors.InitiateCallCallResponseResponseBody	404	application/json
errors.InitiateCallCallResponse422ResponseBody	422	application/json
errors.InitiateCallCallResponse500ResponseBody	500	application/json
errors.SDKError	4XX, 5XX	*/*

Example

import air
from air.models import errors, shared

s = air.Air(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)

res = None
try:
    res = s.call.initiate_call(request=shared.Call(
    phone='874.397.6390 x76992',
    prompt_id=230621,
))

except errors.InitiateCallResponseBody as e:
    # handle exception
    raise(e)
except errors.InitiateCallCallResponseBody as e:
    # handle exception
    raise(e)
except errors.InitiateCallCallResponseResponseBody as e:
    # handle exception
    raise(e)
except errors.InitiateCallCallResponse422ResponseBody as e:
    # handle exception
    raise(e)
except errors.InitiateCallCallResponse500ResponseBody as e:
    # handle exception
    raise(e)
except errors.SDKError as e:
    # handle exception
    raise(e)

if res.object is not None:
    # handle response
    pass

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	https://chat.air.ai/api/v1	None

Example

import air
from air.models import shared

s = air.Air(
    server_idx=0,
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.call.initiate_call(request=shared.Call(
    phone='874.397.6390 x76992',
    prompt_id=230621,
))

if res.object is not None:
    # handle response
    pass

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

import air
from air.models import shared

s = air.Air(
    server_url="https://chat.air.ai/api/v1",
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.call.initiate_call(request=shared.Call(
    phone='874.397.6390 x76992',
    prompt_id=230621,
))

if res.object is not None:
    # handle response
    pass

Custom HTTP Client

The Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session object.

For example, you could specify a header for every request that this sdk makes as follows:

import air
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = air.Air(client=http_client)

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
bearer_auth	http	HTTP Bearer

To authenticate with the API the bearer_auth parameter must be set when initializing the SDK client instance. For example:

import air
from air.models import shared

s = air.Air(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.call.initiate_call(request=shared.Call(
    phone='874.397.6390 x76992',
    prompt_id=230621,
))

if res.object is not None:
    # handle response
    pass

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy