api.md

Shared Types

from imagekitio.types import (
    BaseOverlay,
    ExtensionConfig,
    Extensions,
    GetImageAttributesOptions,
    ImageOverlay,
    Overlay,
    OverlayPosition,
    OverlayTiming,
    ResponsiveImageAttributes,
    SavedExtension,
    SolidColorOverlay,
    SolidColorOverlayTransformation,
    SrcOptions,
    StreamingResolution,
    SubtitleOverlay,
    SubtitleOverlayTransformation,
    TextOverlay,
    TextOverlayTransformation,
    Transformation,
    TransformationPosition,
    VideoOverlay,
)

CustomMetadataFields

Types:

from imagekitio.types import (
    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:

from imagekitio.types import (
    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:

from imagekitio.types.files import (
    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:

from imagekitio.types.files import VersionListResponse, 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:

from imagekitio.types import SavedExtensionListResponse

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

Assets

Types:

from imagekitio.types import AssetListResponse

Methods:

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

Cache

Invalidation

Types:

from imagekitio.types.cache import InvalidationCreateResponse, InvalidationGetResponse

Methods:

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

Folders

Types:

from imagekitio.types import (
    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:

from imagekitio.types.folders import JobGetResponse

Methods:

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

Accounts

Usage

Types:

from imagekitio.types.accounts import UsageGetResponse

Methods:

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

Origins

Types:

from imagekitio.types.accounts import OriginRequest, 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:

from imagekitio.types.accounts import (
    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:

from imagekitio.types.beta.v2 import FileUploadResponse

Methods:

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

Webhooks

Types:

from imagekitio.types import (
    BaseWebhookEvent,
    UploadPostTransformErrorEvent,
    UploadPostTransformSuccessEvent,
    UploadPreTransformErrorEvent,
    UploadPreTransformSuccessEvent,
    VideoTransformationAcceptedEvent,
    VideoTransformationErrorEvent,
    VideoTransformationReadyEvent,
    UnsafeUnwrapWebhookEvent,
    UnwrapWebhookEvent,
)