api.md

Shared Types

fromimagekitio.typesimport (
BaseOverlay,
ExtensionConfig,
Extensions,
GetImageAttributesOptions,
ImageOverlay,
NamedTransformation,
Overlay,
OverlayPosition,
OverlayTiming,
ResponsiveImageAttributes,
SavedExtension,
SolidColorOverlay,
SolidColorOverlayTransformation,
SrcOptions,
StreamingResolution,
SubtitleOverlay,
SubtitleOverlayTransformation,
TextOverlay,
TextOverlayTransformation,
Transformation,
TransformationPosition,
VideoOverlay,
)

CustomMetadataFields

Types:

fromimagekitio.typesimport (
CustomMetadataField,
CustomMetadataFieldListResponse,
CustomMetadataFieldDeleteResponse,
)

Methods:

• client.custom_metadata_fields.create(**params) -> CustomMetadataField
• client.custom_metadata_fields.update(id, **params) -> CustomMetadataField
• client.custom_metadata_fields.list(**params) -> CustomMetadataFieldListResponse
• client.custom_metadata_fields.delete(id) -> CustomMetadataFieldDeleteResponse

Files

Types:

fromimagekitio.typesimport (
File,
Folder,
Metadata,
UpdateFileRequest,
FileUpdateResponse,
FileCopyResponse,
FileMoveResponse,
FileRenameResponse,
FileUploadResponse,
)

Methods:

• client.files.update(file_id, **params) -> FileUpdateResponse
• client.files.delete(file_id) -> None
• client.files.copy(**params) -> FileCopyResponse
• client.files.get(file_id) -> File
• client.files.move(**params) -> FileMoveResponse
• client.files.rename(**params) -> FileRenameResponse
• client.files.upload(**params) -> FileUploadResponse

Bulk

Types:

fromimagekitio.types.filesimport (
BulkDeleteResponse,
BulkAddTagsResponse,
BulkRemoveAITagsResponse,
BulkRemoveTagsResponse,
)

Methods:

• client.files.bulk.delete(**params) -> BulkDeleteResponse
• client.files.bulk.add_tags(**params) -> BulkAddTagsResponse
• client.files.bulk.remove_ai_tags(**params) -> BulkRemoveAITagsResponse
• client.files.bulk.remove_tags(**params) -> BulkRemoveTagsResponse

Versions

Types:

fromimagekitio.types.filesimportVersionListResponse, VersionDeleteResponse

Methods:

• client.files.versions.list(file_id) -> VersionListResponse
• client.files.versions.delete(version_id, *, file_id) -> VersionDeleteResponse
• client.files.versions.get(version_id, *, file_id) -> File
• client.files.versions.restore(version_id, *, file_id) -> File

Metadata

Methods:

• client.files.metadata.get(file_id) -> Metadata
• client.files.metadata.get_from_url(**params) -> Metadata

SavedExtensions

Types:

fromimagekitio.typesimportSavedExtensionListResponse

Methods:

• client.saved_extensions.create(**params) -> SavedExtension
• client.saved_extensions.update(id, **params) -> SavedExtension
• client.saved_extensions.list() -> SavedExtensionListResponse
• client.saved_extensions.delete(id) -> None
• client.saved_extensions.get(id) -> SavedExtension

NamedTransformations

Types:

fromimagekitio.typesimportNamedTransformationListResponse

Methods:

• client.named_transformations.create(**params) -> NamedTransformation
• client.named_transformations.update(id, **params) -> NamedTransformation
• client.named_transformations.list() -> NamedTransformationListResponse
• client.named_transformations.delete(id) -> None
• client.named_transformations.get(id) -> NamedTransformation

Assets

Types:

fromimagekitio.typesimportAssetListResponse

Methods:

• client.assets.list(**params) -> AssetListResponse

Cache

Invalidation

Types:

fromimagekitio.types.cacheimportInvalidationCreateResponse, InvalidationGetResponse

Methods:

• client.cache.invalidation.create(**params) -> InvalidationCreateResponse
• client.cache.invalidation.get(request_id) -> InvalidationGetResponse

Folders

Types:

fromimagekitio.typesimport (
FolderCreateResponse,
FolderDeleteResponse,
FolderCopyResponse,
FolderMoveResponse,
FolderRenameResponse,
)

Methods:

• client.folders.create(**params) -> FolderCreateResponse
• client.folders.delete(**params) -> FolderDeleteResponse
• client.folders.copy(**params) -> FolderCopyResponse
• client.folders.move(**params) -> FolderMoveResponse
• client.folders.rename(**params) -> FolderRenameResponse

Job

Types:

fromimagekitio.types.foldersimportJobGetResponse

Methods:

• client.folders.job.get(job_id) -> JobGetResponse

Accounts

Usage

Types:

fromimagekitio.types.accountsimportUsageGetResponse

Methods:

• client.accounts.usage.get(**params) -> UsageGetResponse

UsageAnalytics

Types:

fromimagekitio.types.accountsimportRequestBandwidthEntry, UsageAnalyticsResponse

Methods:

• client.accounts.usage_analytics.get(**params) -> UsageAnalyticsResponse

Origins

Types:

fromimagekitio.types.accountsimportOriginRequest, OriginResponse, OriginListResponse

Methods:

• client.accounts.origins.create(**params) -> OriginResponse
• client.accounts.origins.update(id, **params) -> OriginResponse
• client.accounts.origins.list() -> OriginListResponse
• client.accounts.origins.delete(id) -> None
• client.accounts.origins.get(id) -> OriginResponse

URLEndpoints

Types:

fromimagekitio.types.accountsimport (
URLEndpointRequest,
URLEndpointResponse,
URLEndpointListResponse,
)

Methods:

• client.accounts.url_endpoints.create(**params) -> URLEndpointResponse
• client.accounts.url_endpoints.update(id, **params) -> URLEndpointResponse
• client.accounts.url_endpoints.list() -> URLEndpointListResponse
• client.accounts.url_endpoints.delete(id) -> None
• client.accounts.url_endpoints.get(id) -> URLEndpointResponse

Beta

V2

Files

Types:

fromimagekitio.types.beta.v2importFileUploadResponse

Methods:

• client.beta.v2.files.upload(**params) -> FileUploadResponse

Webhooks

Types:

fromimagekitio.typesimport (
BaseWebhookEvent,
FileCreateEvent,
FileDeleteEvent,
FileUpdateEvent,
FileVersionCreateEvent,
FileVersionDeleteEvent,
UploadPostTransformErrorEvent,
UploadPostTransformSuccessEvent,
UploadPreTransformErrorEvent,
UploadPreTransformSuccessEvent,
VideoTransformationAcceptedEvent,
VideoTransformationErrorEvent,
VideoTransformationReadyEvent,
UnsafeUnwrapWebhookEvent,
UnwrapWebhookEvent,
)