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

Account

get

account.get Read the account email, plan, API usage and quota Risk: read
Input: empty object Output

Folders

create

folders.create Create a folder to group templates and renders Risk: write
Input Output

delete

folders.delete Delete a folder Risk: destructive · Irreversible
Input Output

list

folders.list List folders with their template counts Risk: read
Input Output: object[]

update

folders.update Rename a folder Risk: write
Input Output

Fonts

list

fonts.list List the fonts on the account, including uploaded ones Risk: read
Input: empty object Output: object[]

list

galleryFonts.list List the base fonts available in the editor Risk: read
Input: empty object Output: object[]

Renders

create

renders.create Render a template to an image, PDF or video, spending an API credit; layer overrides fill the template Risk: destructive
Input Spends one credit per render; send template, or templates for a batch which answers an array; width and height run from 100 to 5000 and format defaults to jpg. Output: object \| object[]

delete

renders.delete Delete a render and its file; the URL stops working and the credit is not refunded Risk: destructive · Irreversible
Input Output

duplicate

renders.duplicate Duplicate an existing render with the same template and payload, spending an API credit Risk: destructive
Input Output: object \| object[]

get

renders.get Read one render with its URL, dimensions, format and status Risk: read
Input Output

list

renders.list List every render on the account Risk: read
Input: empty object Output: object[]

merge

renders.merge Merge several renders, plus external PDFs when given, into one PDF and return its hosted URL Risk: destructive
Input Always asked to host the merged PDF, because the direct-download form answers the file rather than JSON. Output

Templates

addTags

templates.addTags Append tags to a template, keeping the ones it already has Risk: write
Input The body is a bare JSON array of strings, not an object with a tags key. Output

create

templates.create Create a template from a list of layers, which renders can then use Risk: write
Input
Output

delete

templates.delete Delete a template Risk: destructive · Irreversible
Input Output

get

templates.get Read one template, optionally with its layers or its pages Risk: read
Input Output

layers

templates.layers List a template layers, including locked ones when asked Risk: read
Input Output: object[]

list

templates.list List templates, filtered by name or tag, 25 per page Risk: read
Input page starts at 0 and limit defaults to 25 here; filters are query, width and height. Output: object[]

removeTags

templates.removeTags Remove specific tags from a template Risk: write
Input Output

Uploads

create

uploads.create Upload an image, up to 2 MB, for use as a template layer Risk: write
Input The route takes multipart file bytes up to 2 MB; pass fileName and fileBase64, and contentType when the extension is ambiguous. Output

delete

uploads.delete Delete one or more uploads Risk: destructive · Irreversible
Input ids is sent once per upload as a repeated query value. Output

list

uploads.list List uploads, filtered by name or tag, 15 per page Risk: read
Input Output: object[]