API

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

test

auth.test Test Abyssale API key authentication validity Risk: read

await corsair.abyssale.api.auth.test({});

Input: empty object Output

Name	Type	Required	Description
`company`	`string`	Yes	—
`version`	`string`	No	—

Designs

list

designs.list Get a list of designs in Abyssale Risk: read

await corsair.abyssale.api.designs.list({});

Input

Name	Type	Required	Description
`project_id`	`string`	No	—
`type`	`static \| animated \| printer \| printer_multipage`	No	—

Output: object[]

Output full type

{
  id: string,
  template_id?: string,
  name: string,
  type: string,
  project_id?: string,
  project_name?: string,
  category_id?: string,
  category_name?: string,
  version?: string,
  created_at?: number,
  updated_at?: number,
  preview_url?: string
}[]

Fonts

list

fonts.list Get a list of available fonts in Abyssale Risk: read

await corsair.abyssale.api.fonts.list({});

Input

Name	Type	Required	Description
`type`	`google \| custom`	No	—

Output: object[]

Output full type

{
  id: string,
  name: string,
  type: google | custom,
  available_weights: (
    number | string
  )[]
}[]

Generation

batch

generation.batch Start an asynchronous multi-format generation from an Abyssale design Risk: write

await corsair.abyssale.api.generation.batch({});

Input

Name	Type	Required	Description
`designId`	`string`	Yes	—
`elements`	`object`	No	—
`template_format_names`	`string[]`	No	—
`callback_url`	`string`	No	—
`image_file_type`	`png \| jpeg \| webp \| avif \| gif \| pdf \| html5 \| mp4 \| auto`	No	—
`file_compression_level`	`number`	No	—
`html5`	`object`	No	—
`gif`	`object`	No	—
`video`	`object`	No	—
`print`	`object`	No	—
`original_visual_id`	`string`	No	—
`pages`	`object`	No	—

elements full type

{
}

html5 full type

{
  page_title?: string,
  click_tag?: string,
  ad_network?: string,
  include_backup_image?: boolean,
  repeat?: boolean
}

gif full type

{
  max_fps?: number,
  repeat?: boolean
}

video full type

{
  fps?: number
}

print full type

{
  color_profile?: string,
  display_crop_marks?: boolean
}

pages full type

{
}

Output

Name	Type	Required	Description
`generation_request_id`	`string`	Yes	—

image

generation.image Synchronously generate a single image from an Abyssale design Risk: write

await corsair.abyssale.api.generation.image({});

Input

Name	Type	Required	Description
`designId`	`string`	Yes	—
`elements`	`object`	No	—
`template_format_name`	`string`	No	—
`image_file_type`	`png \| jpeg \| webp \| avif \| pdf \| auto`	No	—
`file_compression_level`	`number`	No	—
`original_visual_id`	`string`	No	—

elements full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`version`	`number`	No	—
`sharing_id`	`string`	No	—
`file`	`object`	No	—
`format`	`object`	No	—
`template`	`object`	No	—
`project`	`object`	No	—

file full type

{
  type?: string,
  url?: string,
  cdn_url?: string,
  fallback_image_url?: string,
  filename?: string
}

format full type

{
  id?: string,
  width?: number,
  height?: number,
  unit?: string
}

template full type

{
  id?: string,
  name?: string,
  created_at?: number,
  updated_at?: number
}

project full type

{
  id?: string,
  name?: string
}

status

generation.status Poll the status of an asynchronous generation request Risk: read

await corsair.abyssale.api.generation.status({});

Input

Name	Type	Required	Description
`generationRequestId`	`string`	Yes	—

Output

Name	Type	Required	Description
`is_finalized`	`boolean`	Yes	—
`id`	`string`	Yes	—
`banners`	`object[]`	Yes	—
`errors`	`object[]`	Yes	—

banners full type

{
  id: string,
  version?: number,
  sharing_id?: string,
  file?: {
    type?: string,
    url?: string,
    cdn_url?: string,
    fallback_image_url?: string,
    filename?: string
  },
  format?: {
    id?: string,
    width?: number,
    height?: number,
    unit?: string
  },
  template?: {
    id?: string,
    name?: string,
    created_at?: number,
    updated_at?: number
  },
  project?: {
    id?: string,
    name?: string
  }
}[]

errors full type

{
  template_format_name: string,
  reason: string
}[]

Projects

create

projects.create Create a new project in Abyssale Risk: write

await corsair.abyssale.api.projects.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`created_at_ts`	`number`	Yes	—
`version`	`string`	No	—

Overview

Plugins

Auth

test

Designs

list

Fonts

list

Generation

batch

image

status

Projects

create

​Auth

​test

​Designs

​list

​Fonts

​list

​Generation

​batch

​image

​status

​Projects

​create

Auth

test

Designs

list

Fonts

list

Generation

batch

image

status

Projects

create