API

Every alttextai.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.

Account

get

account.get Get AltText.ai account settings and usage Risk: read

await corsair.alttextai.api.account.get({});

Input: empty object Output

Name	Type	Required	Description
`name`	`string`	No	—
`webhook_url`	`string`	No	—
`notification_email`	`string`	No	—
`usage`	`number`	No	—
`usage_limit`	`number`	No	—
`whitelabel`	`boolean`	No	—
`default_lang`	`string`	No	—
`ending_period`	`boolean`	No	—
`no_quotes`	`boolean`	No	—
`remove_symbols`	`string[]`	No	—
`gpt_prompt`	`string`	No	—
`max_chars`	`number`	No	—
`subscription`	`object`	No	—
`errors`	`object`	No	—

subscription full type

{
  plan_name?: string,
  usage_quota?: number,
  status?: string,
  expires_at?: string
}

errors full type

{
}

update

account.update Update AltText.ai account settings Risk: write

await corsair.alttextai.api.account.update({});

Input

Name	Type	Required	Description
`account`	`object`	Yes	—

account full type

{
  name?: string,
  webhook_url?: string,
  notification_email?: string,
  max_chars?: number,
  gpt_prompt?: string | null,
  remove_symbols?: string[]
}

Output

Name	Type	Required	Description
`name`	`string`	No	—
`webhook_url`	`string`	No	—
`notification_email`	`string`	No	—
`usage`	`number`	No	—
`usage_limit`	`number`	No	—
`whitelabel`	`boolean`	No	—
`default_lang`	`string`	No	—
`ending_period`	`boolean`	No	—
`no_quotes`	`boolean`	No	—
`remove_symbols`	`string[]`	No	—
`gpt_prompt`	`string`	No	—
`max_chars`	`number`	No	—
`subscription`	`object`	No	—
`errors`	`object`	No	—

subscription full type

{
  plan_name?: string,
  usage_quota?: number,
  status?: string,
  expires_at?: string
}

errors full type

{
}

Images

bulkCreate

images.bulkCreate Upload a CSV of image URLs for batch alt text generation Risk: write

await corsair.alttextai.api.images.bulkCreate({});

Input

Name	Type	Required	Description
`file`	`custom`	Yes	CSV file with image URLs to process
`email`	`string`	No	Optional email for bulk upload results

Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`rows`	`number`	No	—
`row_errors`	`tuple[]`	No	—
`error`	`string`	No	—

create

images.create Add an image and generate AI alt text from URL or base64 data Risk: write

await corsair.alttextai.api.images.create({});

Input

Name	Type	Required	Description
`image`	`object`	Yes	—
`async`	`boolean`	No	—
`lang`	`string`	No	—
`max_chars`	`number`	No	—
`model_name`	`describe-detailed \| describe-regular \| describe-factual \| succinct-describe-factual \| describe-terse`	No	—
`keywords`	`string[]`	No	—
`negative_keywords`	`string[]`	No	—
`keyword_source`	`string`	No	—
`gpt_prompt`	`string`	No	—
`overwrite`	`boolean`	No	—
`timeout_secs`	`number`	No	—
`webhook_url`	`string`	No	—
`ecomm`	`object`	No	—

image full type

{
  url?: string,
  raw?: string,
  asset_id?: string,
  metadata?: {
  }
}

ecomm full type

{
  product?: string,
  brand?: string,
  color?: string
}

Output

Name	Type	Required	Description
`asset_id`	`string`	No	—
`url`	`string`	No	—
`alt_text`	`string`	No	—
`alt_texts`	`object`	No	—
`tags`	`string[]`	No	—
`metadata`	`object`	No	—
`created_at`	`number`	No	—
`credits_used`	`number`	No	—
`errors`	`object`	No	—
`error_code`	`string`	No	—

alt_texts full type

{
}

metadata full type

{
}

errors full type

{
}

delete

images.delete Delete an image from the AltText.ai library Risk: destructive

await corsair.alttextai.api.images.delete({});

Input

Name	Type	Required	Description
`assetId`	`string`	Yes	Asset ID of the image to delete

Output

Name	Type	Required	Description
`asset_id`	`string`	No	—
`url`	`string`	No	—
`alt_text`	`string`	No	—
`alt_texts`	`object`	No	—
`tags`	`string[]`	No	—
`metadata`	`object`	No	—
`created_at`	`number`	No	—
`credits_used`	`number`	No	—
`errors`	`object`	No	—
`error_code`	`string`	No	—

alt_texts full type

{
}

metadata full type

{
}

errors full type

{
}

get

images.get Retrieve image metadata and alt text by asset ID Risk: read

await corsair.alttextai.api.images.get({});

Input

Name	Type	Required	Description
`assetId`	`string`	Yes	Asset ID of the image

Output

Name	Type	Required	Description
`asset_id`	`string`	No	—
`url`	`string`	No	—
`alt_text`	`string`	No	—
`alt_texts`	`object`	No	—
`tags`	`string[]`	No	—
`metadata`	`object`	No	—
`created_at`	`number`	No	—
`credits_used`	`number`	No	—
`errors`	`object`	No	—
`error_code`	`string`	No	—

alt_texts full type

{
}

metadata full type

{
}

errors full type

{
}

list

images.list List images in the AltText.ai library with pagination Risk: read

await corsair.alttextai.api.images.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	Page number (starts at 1)
`limit`	`number`	No	Results per page (max 100)
`url`	`string`	No	Exact image URL filter (no wildcards)

Output

Name	Type	Required	Description
`images`	`object[]`	Yes	—

images full type

{
  asset_id?: string,
  url?: string,
  alt_text?: string | null,
  alt_texts?: {
  },
  tags?: string[],
  metadata?: {
  },
  created_at?: number,
  credits_used?: number,
  errors?: {
  },
  error_code?: string | null
}[]

pageScrape

images.pageScrape Scrape a web page and queue alt text for all images found Risk: write

await corsair.alttextai.api.images.pageScrape({});

Input

Name	Type	Required	Description
`page_scrape`	`object`	Yes	—
`keywords`	`string[]`	No	—
`negative_keywords`	`string[]`	No	—
`lang`	`string`	No	—
`include_existing`	`boolean`	No	—

page_scrape full type

{
  url?: string,
  html?: string
}

Output

Name	Type	Required	Description
`url`	`string`	No	—
`total_processed`	`number`	No	—
`errors`	`any`	No	—
`scraped_images`	`object[]`	No	—

scraped_images full type

{
  src?: string,
  alt?: string | null,
  width?: number | null,
  height?: number | null,
  skip_reason?: string | null
}[]

search

images.search Search images by alt text, asset ID, or URL substring Risk: read

await corsair.alttextai.api.images.search({});

Input

Name	Type	Required	Description
`q`	`string`	Yes	Search query (alt text, asset ID, or URL substring)
`page`	`number`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`images`	`object[]`	Yes	—

images full type

{
  asset_id?: string,
  url?: string,
  alt_text?: string | null,
  alt_texts?: {
  },
  tags?: string[],
  metadata?: {
  },
  created_at?: number,
  credits_used?: number,
  errors?: {
  },
  error_code?: string | null
}[]

update

images.update Update alt text or metadata for an existing image Risk: write

await corsair.alttextai.api.images.update({});

Input

Name	Type	Required	Description
`assetId`	`string`	Yes	Asset ID of the image to update
`lang`	`string`	No	Language code(s), comma-separated
`overwrite`	`boolean`	No	—
`image`	`object`	Yes	—

image full type

{
  alt_text?: string,
  asset_id?: string,
  metadata?: {
  }
}

Output

Name	Type	Required	Description
`asset_id`	`string`	No	—
`url`	`string`	No	—
`alt_text`	`string`	No	—
`alt_texts`	`object`	No	—
`tags`	`string[]`	No	—
`metadata`	`object`	No	—
`created_at`	`number`	No	—
`credits_used`	`number`	No	—
`errors`	`object`	No	—
`error_code`	`string`	No	—

alt_texts full type

{
}

metadata full type

{
}

errors full type

{
}

Overview

Plugins

Account

get

update

Images

bulkCreate

create

delete

get

list

pageScrape

search

update

​Account

​get

​update

​Images

​bulkCreate

​create

​delete

​get

​list

​pageScrape

​search

​update

Account

get

update

Images

bulkCreate

create

delete

get

list

pageScrape

search

update