Python Client SDK Generated by Speakeasy
Project description
air-sdk-python
SDK Installation
pip install air-sdk-python
SDK Example Usage
import air
from air.models import shared
s = air.Air(
bearer_auth="",
)
req = shared.Call(
metadata=shared.Metadata(),
phone='874.397.6390 x76992',
prompt_id=230621,
)
res = s.call.initiate_call(req)
if res.two_hundred_application_json_object is not None:
# handle response
pass
Available Resources and Operations
.call
- initiate_call - Initiate a call
Pagination
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a Next
method that can be called to pull down the next group of results. If the
return value of Next
is None
, then there are no more pages to be fetched.
Here's an example of one such pagination call:
Error Handling
Handling errors in your SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
Example
import air
from air.models import shared
s = air.Air(
bearer_auth="",
)
req = shared.Call(
metadata=shared.Metadata(),
phone='874.397.6390 x76992',
prompt_id=230621,
)
res = None
try:
res = s.call.initiate_call(req)
except (401_application/json_object) as e:
print(e) # handle exception
except (403_application/json_object) as e:
print(e) # handle exception
except (404_application/json_object) as e:
print(e) # handle exception
except (422_application/json_object) as e:
print(e) # handle exception
except (500_application/json_object) as e:
print(e) # handle exception
if res.two_hundred_application_json_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 |
For example:
import air
from air.models import shared
s = air.Air(
server_idx=0,
bearer_auth="",
)
req = shared.Call(
metadata=shared.Metadata(),
phone='874.397.6390 x76992',
prompt_id=230621,
)
res = s.call.initiate_call(req)
if res.two_hundred_application_json_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="",
)
req = shared.Call(
metadata=shared.Metadata(),
phone='874.397.6390 x76992',
prompt_id=230621,
)
res = s.call.initiate_call(req)
if res.two_hundred_application_json_object is not None:
# handle response
pass
Custom HTTP Client
The Python SDK makes API calls using the (requests)[https://pypi.org/project/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 your 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
Your 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="",
)
req = shared.Call(
metadata=shared.Metadata(),
phone='874.397.6390 x76992',
prompt_id=230621,
)
res = s.call.initiate_call(req)
if res.two_hundred_application_json_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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for air_sdk_python-0.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 812ded6db451952ed69930b56d7aab394591dc4ef568181bc918e4c8963f7d39 |
|
MD5 | 8872c2c7a256e28dc49e089c45d2fc5d |
|
BLAKE2b-256 | 8f1a5064be1ccdbc9bb9022ca8a4ea4335945407590ab6012fac8ef4186007b3 |