Skip to content
  • Auto
  • Light
  • Dark

Update

Update API Key for a Model
inference.api_keys.update(strpath_api_key_uuid, APIKeyUpdateParams**kwargs) -> APIKeyUpdateResponse
put/v2/gen-ai/models/api_keys/{api_key_uuid}

To update a model API key, send a PUT request to /v2/gen-ai/models/api_keys/{api_key_uuid}.

ParametersExpand Collapse
api_key_uuid: str
api_key_uuid: str
name: Optional[str]

Name

ReturnsExpand Collapse
class APIKeyUpdateResponse:
api_key_info: Optional[APIModelAPIKeyInfo]

Model API Key Info

from gradient import Gradient

client = Gradient()
api_key = client.inference.api_keys.update(
    path_api_key_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(api_key.api_key_info)
{
  "api_key_info": {
    "created_at": "2023-01-01T00:00:00Z",
    "created_by": "12345",
    "deleted_at": "2023-01-01T00:00:00Z",
    "name": "example name",
    "secret_key": "example string",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}
Returns Examples
{
  "api_key_info": {
    "created_at": "2023-01-01T00:00:00Z",
    "created_by": "12345",
    "deleted_at": "2023-01-01T00:00:00Z",
    "name": "example name",
    "secret_key": "example string",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}