MagickMind
PythonModels

Api Keys (v1)

Reference for magick_mind.models.v1.api_keys.

magick_mind.models.v1.api_keys

API Keys models for Magick Mind SDK v1 API.

Provides Pydantic models for creating and managing API keys for authenticating requests to the backend.

ApiKey

class ApiKey(BaseModel)

API key metadata (does not include the actual key value).

Represents an API key for making authenticated requests.

KeyResponse

class KeyResponse(BaseModel)

Response containing the actual API key value.

Only returned when creating or updating a key.

CreateApiKeyRequest

class CreateApiKeyRequest(BaseModel)

Request for creating a new API key.

CreateApiKeyResponse

class CreateApiKeyResponse(BaseModel)

Response for API key creation.

ListApiKeysResponse

class ListApiKeysResponse(BaseModel)

Response for listing API keys.

Uses standardized pagination format: {data: [], paging: {}}.

ListApiKeysResponse.keys

@property
def keys() -> list[ApiKey]

Alias for data field (backward compatibility).

UpdateApiKeyRequest

class UpdateApiKeyRequest(BaseModel)

Request for updating an existing API key.

UpdateApiKeyResponse

class UpdateApiKeyResponse(BaseModel)

Response for API key update.

DeleteApiKeyRequest

class DeleteApiKeyRequest(BaseModel)

Request for deleting an API key.

DeleteApiKeyResponse

class DeleteApiKeyResponse(BaseModel)

Response for API key deletion.

On this page