Skip to main content

Getting Started with OpenAI

Introduction

The OpenAI API can be applied to virtually any task that involves understanding or generating natural language or code. We offer a spectrum of models with different levels of power suitable for different tasks, as well as the ability to fine-tune your own custom models. These models can be used for everything from content generation to semantic search and classification.

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install open-api-apimatic==1.0.0

You can also view the package at: https://pypi.python.org/pypi/open-api-apimatic/1.0.0

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt pytest

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance HttpClient The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ['GET', 'PUT']
bearer_auth_credentials BearerAuthCredentials The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

from openai.configuration import Environment
from openai.http.auth.o_auth_2 import BearerAuthCredentials
from openai.openai_client import OpenaiClient

client = OpenaiClient(
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION
)

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

HTTP

Utilities

Metadata

Release files for open-api-apimatic 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for open-api-apimatic 1.0.0
File Size Uploaded Provenance Actions
open_api_apimatic-1.0.0.tar.gz 20.2 kB Without provenance Details for open_api_apimatic-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for open-api-apimatic 1.0.0
File Interpreter ABI Platform Actions
open_api_apimatic-1.0.0-py3-none-any.whl Python 3 none any Details for open_api_apimatic-1.0.0-py3-none-any.whl

Total release size: 74.4 kB

Release files / open_api_apimatic-1.0.0.tar.gz

Download URL open_api_apimatic-1.0.0.tar.gz
Size 20.2 kB
Tags Source
SHA-256 checksum
How to use checksums
55774b71796fa674d814330d1857d40d5b84856a6b4cad57c68e7921c3d88477
BLAKE2b-256 checksum
How to use checksums
f40412491735c1993abffda2ba526c2b06bb86abfee02dc1db20e7090f403290
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Release files / open_api_apimatic-1.0.0-py3-none-any.whl

Download URL open_api_apimatic-1.0.0-py3-none-any.whl
Size 54.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2e33b242a4d71cf9b5349db6ef1575b89ce99e82c79c246bf4df4b3a59c9e5a3
BLAKE2b-256 checksum
How to use checksums
9881c462c703009d88144073eeb017cf9d7c5469c2e546f540836badaef5f442
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Security for open-api-apimatic 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page