View Source OpenAi.Operations (OpenAI REST API Client v1.0.0)

Provides API endpoints related to operations

Summary

Types

admin_api_keys_delete_200_json_resp()

Functions

admin_api_keys_create(body, opts \\ [])

Create an organization admin API key

admin_api_keys_delete(key_id, opts \\ [])

Delete an organization admin API key

admin_api_keys_get(key_id, opts \\ [])

Retrieve a single organization API key

admin_api_keys_list(opts \\ [])

List organization API keys

Types

admin_api_keys_delete_200_json_resp()

@type admin_api_keys_delete_200_json_resp() :: %{
  deleted: boolean() | nil,
  id: String.t() | nil,
  object: String.t() | nil
}

Functions

admin_api_keys_create(body, opts \\ [])

@spec admin_api_keys_create(body :: map(), opts :: keyword()) ::
  {:ok, OpenAi.AdminApiKey.t()} | {:error, OpenAi.Error.error()}

Create an organization admin API key

Create a new admin-level API key for the organization.

admin_api_keys_delete(key_id, opts \\ [])

@spec admin_api_keys_delete(key_id :: String.t(), opts :: keyword()) ::
  {:ok, admin_api_keys_delete_200_json_resp()} | {:error, OpenAi.Error.error()}

Delete an organization admin API key

Delete the specified admin API key.

admin_api_keys_get(key_id, opts \\ [])

@spec admin_api_keys_get(key_id :: String.t(), opts :: keyword()) ::
  {:ok, OpenAi.AdminApiKey.t()} | {:error, OpenAi.Error.error()}

Retrieve a single organization API key

Get details for a specific organization API key by its ID.

admin_api_keys_list(opts \\ [])

@spec admin_api_keys_list(opts :: keyword()) ::
  {:ok, OpenAi.AdminApiKey.List.t()} | {:error, OpenAi.Error.error()}

List organization API keys

Retrieve a paginated list of organization admin API keys.

Options

after
order
limit