api.md

Shared Params Types

• shared.BaseOverlayParam
• shared.ExtensionConfigUnionParam
• shared.ExtensionsParam
• shared.GetImageAttributesOptionsParam
• shared.ImageOverlayParam
• shared.OverlayUnionParam
• shared.OverlayPositionParam
• shared.OverlayTimingParam
• shared.ResponsiveImageAttributesParam
• shared.SavedExtensionParam
• shared.SolidColorOverlayParam
• shared.SolidColorOverlayTransformationParam
• shared.SrcOptionsParam
• shared.StreamingResolution
• shared.SubtitleOverlayParam
• shared.SubtitleOverlayTransformationParam
• shared.TextOverlayParam
• shared.TextOverlayTransformationParam
• shared.TransformationParam
• shared.TransformationPosition
• shared.VideoOverlayParam

Shared Response Types

• shared.AITag
• shared.CustomMetadata
• shared.EmbeddedMetadata
• shared.ExtensionConfigUnion
• shared.SavedExtension
• shared.SelectedFieldsSchema
• shared.StreamingResolution
• shared.TransformationPosition
• shared.VersionInfo

CustomMetadataFields

Response Types:

• imagekit.CustomMetadataField
• imagekit.CustomMetadataFieldDeleteResponse

Methods:

• client.CustomMetadataFields.New(ctx context.Context, body imagekit.CustomMetadataFieldNewParams) (*imagekit.CustomMetadataField, error)
• client.CustomMetadataFields.Update(ctx context.Context, id string, body imagekit.CustomMetadataFieldUpdateParams) (*imagekit.CustomMetadataField, error)
• client.CustomMetadataFields.List(ctx context.Context, query imagekit.CustomMetadataFieldListParams) (*[]imagekit.CustomMetadataField, error)
• client.CustomMetadataFields.Delete(ctx context.Context, id string) (*imagekit.CustomMetadataFieldDeleteResponse, error)

Files

Params Types:

• imagekit.UpdateFileRequestUnionParam

Response Types:

• imagekit.File
• imagekit.Folder
• imagekit.Metadata
• imagekit.FileUpdateResponse
• imagekit.FileCopyResponse
• imagekit.FileMoveResponse
• imagekit.FileRenameResponse
• imagekit.FileUploadResponse

Methods:

• client.Files.Update(ctx context.Context, fileID string, body imagekit.FileUpdateParams) (*imagekit.FileUpdateResponse, error)
• client.Files.Delete(ctx context.Context, fileID string) error
• client.Files.Copy(ctx context.Context, body imagekit.FileCopyParams) (*imagekit.FileCopyResponse, error)
• client.Files.Get(ctx context.Context, fileID string) (*imagekit.File, error)
• client.Files.Move(ctx context.Context, body imagekit.FileMoveParams) (*imagekit.FileMoveResponse, error)
• client.Files.Rename(ctx context.Context, body imagekit.FileRenameParams) (*imagekit.FileRenameResponse, error)
• client.Files.Upload(ctx context.Context, body imagekit.FileUploadParams) (*imagekit.FileUploadResponse, error)

Bulk

Response Types:

• imagekit.FileBulkDeleteResponse
• imagekit.FileBulkAddTagsResponse
• imagekit.FileBulkRemoveAITagsResponse
• imagekit.FileBulkRemoveTagsResponse

Methods:

• client.Files.Bulk.Delete(ctx context.Context, body imagekit.FileBulkDeleteParams) (*imagekit.FileBulkDeleteResponse, error)
• client.Files.Bulk.AddTags(ctx context.Context, body imagekit.FileBulkAddTagsParams) (*imagekit.FileBulkAddTagsResponse, error)
• client.Files.Bulk.RemoveAITags(ctx context.Context, body imagekit.FileBulkRemoveAITagsParams) (*imagekit.FileBulkRemoveAITagsResponse, error)
• client.Files.Bulk.RemoveTags(ctx context.Context, body imagekit.FileBulkRemoveTagsParams) (*imagekit.FileBulkRemoveTagsResponse, error)

Versions

Response Types:

• imagekit.FileVersionDeleteResponse

Methods:

• client.Files.Versions.List(ctx context.Context, fileID string) (*[]imagekit.File, error)
• client.Files.Versions.Delete(ctx context.Context, versionID string, body imagekit.FileVersionDeleteParams) (*imagekit.FileVersionDeleteResponse, error)
• client.Files.Versions.Get(ctx context.Context, versionID string, query imagekit.FileVersionGetParams) (*imagekit.File, error)
• client.Files.Versions.Restore(ctx context.Context, versionID string, body imagekit.FileVersionRestoreParams) (*imagekit.File, error)

Metadata

Methods:

• client.Files.Metadata.Get(ctx context.Context, fileID string) (*imagekit.Metadata, error)
• client.Files.Metadata.GetFromURL(ctx context.Context, query imagekit.FileMetadataGetFromURLParams) (*imagekit.Metadata, error)

SavedExtensions

Methods:

• client.SavedExtensions.New(ctx context.Context, body imagekit.SavedExtensionNewParams) (*shared.SavedExtension, error)
• client.SavedExtensions.Update(ctx context.Context, id string, body imagekit.SavedExtensionUpdateParams) (*shared.SavedExtension, error)
• client.SavedExtensions.List(ctx context.Context) (*[]shared.SavedExtension, error)
• client.SavedExtensions.Delete(ctx context.Context, id string) error
• client.SavedExtensions.Get(ctx context.Context, id string) (*shared.SavedExtension, error)

Assets

Response Types:

• imagekit.AssetListResponseUnion

Methods:

• client.Assets.List(ctx context.Context, query imagekit.AssetListParams) (*[]imagekit.AssetListResponseUnion, error)

Cache

Invalidation

Response Types:

• imagekit.CacheInvalidationNewResponse
• imagekit.CacheInvalidationGetResponse

Methods:

• client.Cache.Invalidation.New(ctx context.Context, body imagekit.CacheInvalidationNewParams) (*imagekit.CacheInvalidationNewResponse, error)
• client.Cache.Invalidation.Get(ctx context.Context, requestID string) (*imagekit.CacheInvalidationGetResponse, error)

Folders

Response Types:

• imagekit.FolderNewResponse
• imagekit.FolderDeleteResponse
• imagekit.FolderCopyResponse
• imagekit.FolderMoveResponse
• imagekit.FolderRenameResponse

Methods:

• client.Folders.New(ctx context.Context, body imagekit.FolderNewParams) (*imagekit.FolderNewResponse, error)
• client.Folders.Delete(ctx context.Context, body imagekit.FolderDeleteParams) (*imagekit.FolderDeleteResponse, error)
• client.Folders.Copy(ctx context.Context, body imagekit.FolderCopyParams) (*imagekit.FolderCopyResponse, error)
• client.Folders.Move(ctx context.Context, body imagekit.FolderMoveParams) (*imagekit.FolderMoveResponse, error)
• client.Folders.Rename(ctx context.Context, body imagekit.FolderRenameParams) (*imagekit.FolderRenameResponse, error)

Job

Response Types:

• imagekit.FolderJobGetResponse

Methods:

• client.Folders.Job.Get(ctx context.Context, jobID string) (*imagekit.FolderJobGetResponse, error)

Accounts

Usage

Response Types:

• imagekit.AccountUsageGetResponse

Methods:

• client.Accounts.Usage.Get(ctx context.Context, query imagekit.AccountUsageGetParams) (*imagekit.AccountUsageGetResponse, error)

Origins

Params Types:

• imagekit.OriginRequestUnionParam

Response Types:

• imagekit.OriginResponseUnion

Methods:

• client.Accounts.Origins.New(ctx context.Context, body imagekit.AccountOriginNewParams) (*imagekit.OriginResponseUnion, error)
• client.Accounts.Origins.Update(ctx context.Context, id string, body imagekit.AccountOriginUpdateParams) (*imagekit.OriginResponseUnion, error)
• client.Accounts.Origins.List(ctx context.Context) (*[]imagekit.OriginResponseUnion, error)
• client.Accounts.Origins.Delete(ctx context.Context, id string) error
• client.Accounts.Origins.Get(ctx context.Context, id string) (*imagekit.OriginResponseUnion, error)

URLEndpoints

Params Types:

• imagekit.URLEndpointRequestParam

Response Types:

• imagekit.URLEndpointResponse

Methods:

• client.Accounts.URLEndpoints.New(ctx context.Context, body imagekit.AccountURLEndpointNewParams) (*imagekit.URLEndpointResponse, error)
• client.Accounts.URLEndpoints.Update(ctx context.Context, id string, body imagekit.AccountURLEndpointUpdateParams) (*imagekit.URLEndpointResponse, error)
• client.Accounts.URLEndpoints.List(ctx context.Context) (*[]imagekit.URLEndpointResponse, error)
• client.Accounts.URLEndpoints.Delete(ctx context.Context, id string) error
• client.Accounts.URLEndpoints.Get(ctx context.Context, id string) (*imagekit.URLEndpointResponse, error)

Beta

V2

Files

Response Types:

• imagekit.BetaV2FileUploadResponse

Methods:

• client.Beta.V2.Files.Upload(ctx context.Context, body imagekit.BetaV2FileUploadParams) (*imagekit.BetaV2FileUploadResponse, error)

Webhooks

Response Types:

• imagekit.BaseWebhookEvent
• imagekit.FileCreateEvent
• imagekit.FileDeleteEvent
• imagekit.FileUpdateEvent
• imagekit.FileVersionCreateEvent
• imagekit.FileVersionDeleteEvent
• imagekit.UploadPostTransformErrorEvent
• imagekit.UploadPostTransformSuccessEvent
• imagekit.UploadPreTransformErrorEvent
• imagekit.UploadPreTransformSuccessEvent
• imagekit.VideoTransformationAcceptedEvent
• imagekit.VideoTransformationErrorEvent
• imagekit.VideoTransformationReadyEvent
• imagekit.UnsafeUnwrapWebhookEventUnion
• imagekit.UnwrapWebhookEventUnion