Delete

API Reference

Models

Providers

OpenAI

Delete OpenAI API Key

models.providers.openai.delete(strapi_key_uuid) -> api_key_infoAPIOpenAIAPIKeyInfoOpenAIDeleteResponse

delete/v2/gen-ai/openai/keys/{api_key_uuid}

To delete an OpenAI API key, send a DELETE request to /v2/gen-ai/openai/keys/{api_key_uuid}.

Parameters

api_key_uuidstr

Returns

OpenAIDeleteResponseclass

DeleteOpenAIAPIKeyOutput is used to return the deleted OpenAI API key.

Hide ParametersShow Parameters

api_key_infoAPIOpenAIAPIKeyInfo

optional

OpenAI API Key Info

HTTPPython

from gradient import Gradient

client = Gradient()
openai = client.models.providers.openai.delete(
    "api_key_uuid",
)
print(openai.api_key_info)

200 Example

{
  "api_key_info": {
    "created_at": "2023-01-01T00:00:00Z",
    "created_by": "\"12345\"",
    "deleted_at": "2023-01-01T00:00:00Z",
    "models": [
      {
        "agreement": {
          "description": "\"example string\"",
          "name": "\"example name\"",
          "url": "\"example string\"",
          "uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
        },
        "created_at": "2023-01-01T00:00:00Z",
        "inference_name": "\"example name\"",
        "inference_version": "\"example string\"",
        "is_foundational": true,
        "metadata": {},
        "name": "\"example name\"",
        "parent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
        "provider": "MODEL_PROVIDER_DIGITALOCEAN",
        "updated_at": "2023-01-01T00:00:00Z",
        "upload_complete": true,
        "url": "\"example string\"",
        "usecases": [
          "MODEL_USECASE_AGENT",
          "MODEL_USECASE_GUARDRAIL"
        ],
        "uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
        "version": {
          "major": 123,
          "minor": 123,
          "patch": 123
        }
      }
    ],
    "name": "\"example name\"",
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
  }
}