API

Every imgbb.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Auth

auth.getApiKey Confirm an ImgBB API key is configured for this account and return a masked preview of it Risk: read

await corsair.imgbb.api.auth.getApiKey({});

Input: empty object Output

Name	Type	Required	Description
`configured`	`boolean`	Yes	Whether an ImgBB API key is configured for this account
`keyPreview`	`string`	Yes	Last 4 characters of the configured key, for identification only

images.upload Upload an image to ImgBB and return the hosted image URLs and metadata Risk: write

await corsair.imgbb.api.images.upload({});

Input

Name	Type	Required	Description
`image`	`string \| custom \| custom \| custom`	Yes	Base64-encoded image data, image URL, or binary data (Blob, File, Buffer, Uint8Array) up to 32 MB per the ImgBB API
`name`	`string`	No	Optional display name for the file
`expiration`	`number`	No	Optional auto-delete window in seconds (60-15552000). Omit to keep the image indefinitely.

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`title`	`string`	No	—
`url_viewer`	`string`	No	—
`url`	`string`	Yes	—
`display_url`	`string`	No	—
`width`	`number`	No	—
`height`	`number`	No	—
`size`	`number`	No	—
`time`	`number`	No	—
`expiration`	`number`	No	—
`image`	`object`	No	—
`thumb`	`object`	No	—
`medium`	`object`	No	—
`delete_url`	`string`	No	—

image full type

{
  filename?: string,
  name?: string,
  mime?: string,
  extension?: string,
  url: string
}

thumb full type

{
  filename?: string,
  name?: string,
  mime?: string,
  extension?: string,
  url: string
}

medium full type

{
  filename?: string,
  name?: string,
  mime?: string,
  extension?: string,
  url: string
}