Contibase

Docs

These are the API docs for https://www.contibase.com.

Contibase combines email, tables, storage, pages, and server functions behind one API.

If you are using Contibase for email, start with email address management, single mail, bulk mail, and mail query endpoints.

The endpoints described here build off that base URL. For example:

https://www.contibase.com/api/v1/tables/{table_id}/bulk_rows

You should place an authorized `CONTIBASE_ACCESS_TOKEN` in request headers as an Auth Bearer. Access Tokens can be user generated at https://www.contibase.com/settings in the Auth tab.

Security Note:

When calling these APIs, always call them from a secure environment, such as your server.

Store your `CONTIBASE_ACCESS_TOKEN` in a private `.env` variable.

If your `CONTIBASE_ACCESS_TOKEN` is leaked, others may gain access to your account and perform harmful operations.

We use snake_case and encourage you to help keep integrations consistent with our docs. Below is an example of calling an endpoint in JavaScript:

async function create_bulk_table_rows(table_id, rows) {
  try {
    const create_bulk_table_rows_res = await fetch(`/api/v1/tables/${table_id}/bulk_rows`, {
      method: 'POST',
      headers: {
        "authorization": `Bearer ${CONTIBASE_ACCESS_TOKEN}`,
        "content-type": "application/json"
      },
      body: JSON.stringify({ rows: rows })
    })
    const create_bulk_table_rows_res_body = await create_bulk_table_rows_res.json()
    if (!create_bulk_table_rows_res.ok) {
      throw new Error(create_bulk_table_rows_res_body?.message ?? 'Error creating bulk table rows.')
    }
    console.log('successfully created bulk rows', create_bulk_table_rows_res_body)
  } catch (err) {
    console.log('Error creating bulk table rows', err)
  }
  }

Some endpoints use form data for the request body and may look something like:

async function ai_remove_image_background(image_url) {
    try {
      const form_data = new FormData();
      const rand_name = Math.random().toString(26).slice(2);
      const res = await fetch(image_url);
      const blob = await res.blob();
      form_data.append("file", blob, rand_name);
      const response = await fetch("/api/v1/tools/remove_background", {
        method: "POST",
        body: form_data
      });
      const res_body = await response.json();
      if (!response.ok) {
        throw new Error(res_body?.message ?? "Error removing image background.");
      }
      console.log("Successfully removed image background", res_body);
    } catch (err) {
      console.log("Error removing image background", err);
    }
  }

Delete Account

delete account (initializes cleanup)

Endpoint

delete/api/v1/accounts/[account_id]

Endpoint Params

account_idstring (path parameter)

Get Account

gets account profile for the account_id

Endpoint

get/api/v1/accounts/[account_id]

Endpoint Params

account_idstring (path parameter)

Get Account Access Tokens

endpoint

Endpoint

get/api/v1/accounts/[account_id]/access_tokens

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Create Account Access Token

endpoint

Endpoint

post/api/v1/accounts/[account_id]/access_tokens

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Get Account Billing

endpoint

Endpoint

get/api/v1/accounts/[account_id]/billing/subscriptions

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Update Account Bio

endpoint

Endpoint

put/api/v1/accounts/[account_id]/bio

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Update Account Color

endpoint

Endpoint

put/api/v1/accounts/[account_id]/color

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Get Account Domains

endpoint

Endpoint

get/api/v1/accounts/[account_id]/domains

Endpoint Params

account_idstring (path parameter)

Delete Domain

endpoint

Endpoint

delete/api/v1/accounts/[account_id]/domains/[domain_id]

Endpoint Params

domain_idstring (path parameter)

Get Domain Config

endpoint

Endpoint

get/api/v1/accounts/[account_id]/domains/[domain_id]/config

Endpoint Params

domain_idstring (path parameter)

Get Domain DNS

endpoint

Endpoint

get/api/v1/accounts/[account_id]/domains/[domain_id]/dns

Endpoint Params

domain_idstring (path parameter)

Get Domain DNS Record

endpoint

Endpoint

get/api/v1/accounts/[account_id]/domains/[domain_id]/dns/[record_id]

Endpoint Params

record_idstring (path parameter)

Get Domain Info

endpoint

Endpoint

get/api/v1/accounts/[account_id]/domains/[domain_id]/info

Endpoint Params

domain_idstring (path parameter)

Set Main Account Domain

endpoint

Endpoint

post/api/v1/accounts/[account_id]/domains/[domain_id]/main

Endpoint Params

domain_idstring (path parameter)

Remove Domain

endpoint

Endpoint

get/api/v1/accounts/[account_id]/domains/[domain_id]/remove

Endpoint Params

domain_idstring (path parameter)

Create Subdomain

endpoint

Endpoint

post/api/v1/accounts/[account_id]/domains/[domain_id]/subdomain

Endpoint Params

domain_idstring (path parameter)

Request Body

jsonsee endpoint details

Get Domain Transfer Info

endpoint

Endpoint

get/api/v1/accounts/[account_id]/domains/[domain_id]/transfer_info

Endpoint Params

domain_idstring (path parameter)

Verify Domain DKIM

endpoint

Endpoint

post/api/v1/accounts/[account_id]/domains/[domain_id]/verify_dkim

Endpoint Params

domain_idstring (path parameter)

Verify Domain Inbound

endpoint

Endpoint

post/api/v1/accounts/[account_id]/domains/[domain_id]/verify_inbound

Endpoint Params

domain_idstring (path parameter)

Verify Domain Return Path

endpoint

Endpoint

post/api/v1/accounts/[account_id]/domains/[domain_id]/verify_return_path

Endpoint Params

domain_idstring (path parameter)

Check Domain Availability

endpoint

Endpoint

get/api/v1/accounts/[account_id]/domains/availability

Endpoint Params

account_idstring (path parameter)

Purchase Domain

endpoint

Endpoint

get/api/v1/accounts/[account_id]/domains/purchase

Endpoint Params

account_idstring (path parameter)

Get Transfer Domain

endpoint

Endpoint

get/api/v1/accounts/[account_id]/domains/transfer

Endpoint Params

account_idstring (path parameter)

Verify Domain Ownership

endpoint

Endpoint

post/api/v1/accounts/[account_id]/domains/verify_ownership

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Get Email Addresses

List the email addresses configured for the account.

Endpoint

get/api/v1/accounts/[account_id]/email_addresses

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Create Email Address

Create an email address on a domain owned by the account.

Endpoint

post/api/v1/accounts/[account_id]/email_addresses

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Delete Email Address

Remove an email address from the account.

Endpoint

delete/api/v1/accounts/[account_id]/email_addresses/[email_id]

Endpoint Params

email_idstring (path parameter)

Request Body

jsonsee endpoint details

Update Email Address

Update an email address display name or note.

Endpoint

put/api/v1/accounts/[account_id]/email_addresses/[email_id]

Endpoint Params

email_idstring (path parameter)

Request Body

jsonsee endpoint details

Get Functions

endpoint

Endpoint

get/api/v1/accounts/[account_id]/functions

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Create Function

endpoint

Endpoint

post/api/v1/accounts/[account_id]/functions

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Delete Function

endpoint

Endpoint

delete/api/v1/accounts/[account_id]/functions/[function_id]

Endpoint Params

function_idstring (path parameter)

Request Body

jsonsee endpoint details

Get Function

endpoint

Endpoint

get/api/v1/accounts/[account_id]/functions/[function_id]

Endpoint Params

function_idstring (path parameter)

Request Body

jsonsee endpoint details

Update Function

endpoint

Endpoint

put/api/v1/accounts/[account_id]/functions/[function_id]

Endpoint Params

function_idstring (path parameter)

Request Body

jsonsee endpoint details

Update Function Crons

endpoint

Endpoint

put/api/v1/accounts/[account_id]/functions/[function_id]/crons

Endpoint Params

function_idstring (path parameter)

Request Body

jsonsee endpoint details

Update Function Description

endpoint

Endpoint

put/api/v1/accounts/[account_id]/functions/[function_id]/description

Endpoint Params

function_idstring (path parameter)

Request Body

jsonsee endpoint details

Update Function Name

endpoint

Endpoint

put/api/v1/accounts/[account_id]/functions/[function_id]/name

Endpoint Params

function_idstring (path parameter)

Request Body

jsonsee endpoint details

Run Function

endpoint

Endpoint

post/api/v1/accounts/[account_id]/functions/[function_id]/run

Endpoint Params

function_idstring (path parameter)

Request Body

jsonsee endpoint details

Generate Function

endpoint

Endpoint

post/api/v1/functions/generate

Endpoint Params

overall_promptstring (path parameter)

existing_functionstring (path parameter)

Request Body

jsonsee endpoint details

Get Account Icon

endpoint

Endpoint

get/api/v1/accounts/[account_id]/icon

Endpoint Params

account_idstring (path parameter)

Request Body

Note: This endpoint should use formData() for the request body

form_datasee endpoint details

Update Account Icon

endpoint

Endpoint

put/api/v1/accounts/[account_id]/icon

Endpoint Params

account_idstring (path parameter)

Request Body

Note: This endpoint should use formData() for the request body

form_datasee endpoint details

Get Account Logo

endpoint

Endpoint

get/api/v1/accounts/[account_id]/logo

Endpoint Params

account_idstring (path parameter)

Request Body

Note: This endpoint should use formData() for the request body

form_datasee endpoint details

Update Account Logo

endpoint

Endpoint

put/api/v1/accounts/[account_id]/logo

Endpoint Params

account_idstring (path parameter)

Request Body

Note: This endpoint should use formData() for the request body

form_datasee endpoint details

Get Mail Transaction

Get a single email transaction with message details and references.

Endpoint

get/api/v1/accounts/[account_id]/mail/[email_transaction_id]

Endpoint Params

email_transaction_idstring (path parameter)

Update Mail Transaction Extra

Update tags, read state, or note for an email transaction.

Endpoint

put/api/v1/accounts/[account_id]/mail/[email_transaction_id]/extra

Endpoint Params

email_transaction_idstring (path parameter)

Request Body

jsonsee endpoint details

Send Bulk Mail

Send a bulk email to users matching a tag.

Endpoint

post/api/v1/accounts/[account_id]/mail/bulk

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Delete Bulk Sent Mail Group

Delete a bulk send group.

Endpoint

delete/api/v1/accounts/[account_id]/mail/bulk/[bulk_send_group_id]

Endpoint Params

bulk_send_group_idstring (path parameter)

Get Account Mail

Query account mail with filters for address, time, status, tags, and tracking fields.

Endpoint

get/api/v1/accounts/[account_id]/mail/q

Endpoint Params

account_idstring (path parameter)

Send Single Email

Send one email transaction from an account email address.

Endpoint

post/api/v1/accounts/[account_id]/mail/single

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Update Mail Tags

Create, update, or delete account-level mail tags.

Endpoint

put/api/v1/accounts/[account_id]/mail/tags

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Update Account Name

endpoint

Endpoint

put/api/v1/accounts/[account_id]/name

Endpoint Params

account_idstring (path parameter)

Request Body

jsonsee endpoint details

Get Account Pages

endpoint

Endpoint

get/api/v1/accounts/[account_id]/pages

Endpoint Params

account_idstring (path parameter)

Query Params

limitstring

offsetstring

qstring

Get Account Passkeys

endpoint

Endpoint

get/api/v1/accounts/[account_id]/passkeys

Endpoint Params

account_idstring (path parameter)

Delete Account Passkey

endpoint

Endpoint

delete/api/v1/accounts/[account_id]/passkeys/[passkey_id]

Endpoint Params

passkey_idstring (path parameter)

Get Account Settings

endpoint

Endpoint

get/api/v1/accounts/[account_id]/settings

Endpoint Params

account_idstring (path parameter)

Get Account Storage

endpoint

Endpoint

get/api/v1/accounts/[account_id]/storage

Endpoint Params

account_idstring (path parameter)

Get Account Tables

endpoint

Endpoint

get/api/v1/accounts/[account_id]/tables

Endpoint Params

account_idstring (path parameter)

Get Account User_table

endpoint

Endpoint

get/api/v1/accounts/[account_id]/user_table

Endpoint Params

account_idstring (path parameter)

Query Params

qstring

Chat Assistant

handles chat interactions with openai tools

Endpoint

post/api/v1/chat_assistant

Request Body

input_contentarray of {type:'text'|'images', text?:string, images?:[{url}] }

previous_message_idstring (optional)

storage_patharray (optional, default ['chat'])

Code Generator

assistant to generate sveltekit-ui example code

Endpoint

post/api/v1/code_generator

Request Body

jsonsee endpoint details

Get Docs

endpoint

Endpoint

get/api/v1/docs

Get Gifs Search

endpoint

Endpoint

get/api/v1/gifs/search

Query Params

bundlestring

langstring

limitstring

offsetstring

qstring

ratingstring

Get Gifs Trending

endpoint

Endpoint

get/api/v1/gifs/trending

Query Params

bundlestring

limitstring

offsetstring

ratingstring

Maps Retrieve

apple maps place retrieve by place_id

Endpoint

post/api/v1/maps/retrieve

Request Body

tokenstring (mapkit)

place_idstring

Maps Search

apple maps search

Endpoint

post/api/v1/maps/search

Request Body

tokenstring (mapkit)

search_valstring

Maps Suggest

apple maps suggest (autocomplete)

Endpoint

post/api/v1/maps/suggest

Request Body

tokenstring (mapkit)

search_valstring

Get Maps Token

get apple mapkit access token

Endpoint

get/api/v1/maps/token

Create Page

endpoint

Endpoint

post/api/v1/pages

Request Body

jsonsee endpoint details

Delete Page

endpoint

Endpoint

delete/api/v1/pages/[page_id_or_full_path]

Endpoint Params

page_id_or_full_pathstring (path parameter)

Request Body

jsonsee endpoint details

Get Page

endpoint

Endpoint

get/api/v1/pages/[page_id_or_full_path]

Endpoint Params

page_id_or_full_pathstring (path parameter)

Request Body

jsonsee endpoint details

Update Page

endpoint

Endpoint

put/api/v1/pages/[page_id_or_full_path]

Endpoint Params

page_id_or_full_pathstring (path parameter)

Request Body

jsonsee endpoint details

Autogenerate Page

endpoint

Endpoint

post/api/v1/pages/autogenerate

Request Body

jsonsee endpoint details

Create Storage Item

uploads a file to storage and creates a db record

Endpoint

post/api/v1/storage

Request Body

Note: This endpoint should use formData() for the request body

account_idstring

overwrite_storage_idstring (optional)

filebinary file (<=8mb)

folder_patharray (optional)

metadataobject (optional)

is_temporarybool (optional)

is_publicbool (optional)

Delete Storage Item

endpoint

Endpoint

delete/api/v1/storage/[storage_id]

Endpoint Params

storage_idstring (path parameter)

Query Params

typestring

Get Storage Item

redirects to a signed url for the requested storage item

Endpoint

get/api/v1/storage/[storage_id]

Endpoint Params

storage_idstring (path parameter)

Query Params

typestring

Update Storage Item Settings

endpoint

Endpoint

put/api/v1/storage/[storage_id]/settings

Endpoint Params

storage_idstring (path parameter)

Request Body

jsonsee endpoint details

Delete Storage Bulk

bulk delete storage items by id

Endpoint

delete/api/v1/storage/bulk

Request Body

storage_idsarray of string ids

Delete Temporary Storage

endpoint

Endpoint

delete/api/v1/storage/delete_temporary

Get Storage Item Structure

endpoint

Endpoint

get/api/v1/storage/structure/[storage_id_or_full_path]

Endpoint Params

storage_id_or_full_pathstring (path parameter)

Get Storage Structure Bulk

fetches multiple storage items by path (use __ delimiter)

Endpoint

get/api/v1/storage/structure/bulk/[full_path]

Endpoint Params

full_pathstring (path parameter)

Create Table

creates a new table

Endpoint

post/api/v1/tables

Request Body

account_idstring

namestring

descriptionstring (optional)

Delete Table

endpoint

Endpoint

delete/api/v1/tables/[table_id]

Get Table

gets table rows and metadata

Endpoint

get/api/v1/tables/[table_id]

Endpoint Params

table_idstring (path parameter)

Query Params

filtersquery param (optional, json string). supports: {"and":[{field,operator,value},...]} with operators eq, lt, gt, lte, gte, like; combine via and/or. example: const filters_obj = { and: [ { field: 'month', operator: 'eq', value: month_number }, { field: 'day_of_month', operator: 'eq', value: day_number } ] }

limitint e.g. 1000

offsetint e.g. 10

qstring

Delete Table Bulk Rows

bulk create or delete rows for a table

Endpoint

delete/api/v1/tables/[table_id]/bulk_rows

Endpoint Params

table_idstring (path parameter)

Request Body

row_idsarray of string ids

Create Table Bulk Rows

bulk create or delete rows for a table

Endpoint

post/api/v1/tables/[table_id]/bulk_rows

Endpoint Params

table_idstring (path parameter)

Request Body

rowsarray of row objects

Create Table Column

creates a new table column. body_content docs below cover the simple render types (text/number/time/color).

Endpoint

post/api/v1/tables/[table_id]/columns

Endpoint Params

table_idstring (path parameter)

Request Body

column{"key":"string. like 'planet'","description":"string|null (optional)","display_order":"number (optional)","is_db_column":"bool (required)","postgres_type":"string (required). example 'text' | 'int' | 'jsonb' | 'text[]'","db_data_type":{"type":"string (required). example 'text_literal' | 'int_literal' | 'object_literal' | ...","attributes":"object (optional)","items":"object (optional, for arrays)","properties":"object (optional, for objects)"},"is_nullable":"bool (optional, default true)","default_value":"any|null (optional)","is_primary_key":"bool (optional, default false)","is_autogenerated":"bool (optional, default false)","is_force_uniqueness":"bool (optional, default false)","is_updatable":"bool (optional, default true)","is_shown":"bool (optional, default true)","is_fixed":"bool (optional, default false)","alignment":"string (optional, default 'left')","min_width":"number (optional)","max_width":"number (optional)","is_use_in_short_display":"bool (optional, default false)","header_content":{"type_id":"string (required). usually 'base_text'","children":"array (optional)","attributes":{"content":"string (optional). header label"},"selector_id":"string (optional)"},"body_content":{"one_of":"base_text | number | time | color","options":{"base_text":{"type_id":"base_text","children":[],"attributes":{"size":"number (optional, default 10)","content_from_variable_path":"array (recommended). example ['variables','rows',['row_i'],'title']"}},"number":{"type_id":"number","children":[],"attributes":{"val_from_variable_path":"array (recommended). example ['variables','rows',['row_i'],'population']"}},"time":{"type_id":"time","children":[],"attributes":{"val_from_variable_path":"array (recommended). example ['variables','rows',['row_i'],'db_epoch_created']","format":"string (optional). example 'epoch' | 'time_full'","display_format":"string (optional). example 'calendar_date'","text_color":"string|null (optional)"}},"color":{"type_id":"color","children":[],"attributes":{"val_from_variable_path":"array (recommended). example ['variables','rows',['row_i'],'color']","size":"number (optional, default 3)","border_radius":"number (optional, default 0.5)","is_show_details":"bool|null (optional)"}}}}}

Delete Table Column

endpoint

Endpoint

delete/api/v1/tables/[table_id]/columns/[column_id]

Endpoint Params

table_idstring (path parameter)

column_idstring (path parameter)

Request Body

jsonsee endpoint details

Update Table Column

updates a table column. supports partial updates (recommended) or full column object.

Endpoint

put/api/v1/tables/[table_id]/columns/[column_id]

Endpoint Params

table_idstring (path parameter)

column_idstring (path parameter)

Request Body

column{"partial":true,"schema":{"key":"string. like 'planet'","description":"string|null (optional)","display_order":"number (optional)","is_db_column":"bool (required)","postgres_type":"string (required). example 'text' | 'int' | 'jsonb' | 'text[]'","db_data_type":{"type":"string (required). example 'text_literal' | 'int_literal' | 'object_literal' | ...","attributes":"object (optional)","items":"object (optional, for arrays)","properties":"object (optional, for objects)"},"is_nullable":"bool (optional, default true)","default_value":"any|null (optional)","is_primary_key":"bool (optional, default false)","is_autogenerated":"bool (optional, default false)","is_force_uniqueness":"bool (optional, default false)","is_updatable":"bool (optional, default true)","is_shown":"bool (optional, default true)","is_fixed":"bool (optional, default false)","alignment":"string (optional, default 'left')","min_width":"number (optional)","max_width":"number (optional)","is_use_in_short_display":"bool (optional, default false)","header_content":{"type_id":"string (required). usually 'base_text'","children":"array (optional)","attributes":{"content":"string (optional). header label"},"selector_id":"string (optional)"},"body_content":{"one_of":"base_text | number | time | color","options":{"base_text":{"type_id":"base_text","children":[],"attributes":{"size":"number (optional, default 10)","content_from_variable_path":"array (recommended). example ['variables','rows',['row_i'],'title']"}},"number":{"type_id":"number","children":[],"attributes":{"val_from_variable_path":"array (recommended). example ['variables','rows',['row_i'],'population']"}},"time":{"type_id":"time","children":[],"attributes":{"val_from_variable_path":"array (recommended). example ['variables','rows',['row_i'],'db_epoch_created']","format":"string (optional). example 'epoch' | 'time_full'","display_format":"string (optional). example 'calendar_date'","text_color":"string|null (optional)"}},"color":{"type_id":"color","children":[],"attributes":{"val_from_variable_path":"array (recommended). example ['variables','rows',['row_i'],'color']","size":"number (optional, default 3)","border_radius":"number (optional, default 0.5)","is_show_details":"bool|null (optional)"}}}}}}

Update Table Description

updates a table's description

Endpoint

put/api/v1/tables/[table_id]/description

Endpoint Params

table_idstring (path parameter)

Request Body

table_descriptionstring

Update Table Function Triggers

updates a table's function triggers

Endpoint

put/api/v1/tables/[table_id]/function_triggers

Endpoint Params

table_idstring (path parameter)

Request Body

function_triggersarray of {trigger_event_type, function_to_call_id, is_enabled}

Update Tables Name

updates a table's name

Endpoint

put/api/v1/tables/[table_id]/name

Endpoint Params

table_idstring (path parameter)

Request Body

table_namestring

Create Table Row

inserts a single row into a specified table

Endpoint

post/api/v1/tables/[table_id]/rows

Endpoint Params

table_idstring (path parameter)

Request Body

row_dataobject of field values

Delete Table Row

deletes a single row by row_id in a specified table

Endpoint

delete/api/v1/tables/[table_id]/rows/[row_id]

Endpoint Params

row_idstring (path parameter)

Request Body

jsonsee endpoint details

Get Table Row

retrieves a single row by row_id for a specified table

Endpoint

get/api/v1/tables/[table_id]/rows/[row_id]

Endpoint Params

row_idstring (path parameter)

Request Body

jsonsee endpoint details

Update Table Row

updates row data in a specified table

Endpoint

put/api/v1/tables/[table_id]/rows/[row_id]

Endpoint Params

row_idstring (path parameter)

Request Body

row_dataobject of updated field values

Update Table Default Sort

updates a table's default sort

Endpoint

put/api/v1/tables/[table_id]/sort

Endpoint Params

table_idstring (path parameter)

Request Body

inputarray of {variable_path, is_ascending}

Create Audio

builds audio and saves to storage

Endpoint

post/api/v1/tools/audio

Request Body

Note: This endpoint should use formData() for the request body

account_idstring

is_text_to_audiobool

text_to_audio_inputstring (optional)

audiobinary audio file (optional)

voice_idstring (optional)

tagsjson (optional)

imagebinary image file (optional)

folder_pathstring or array (optional)

Audio Read Tags

reads id3 tags from an audio file

Endpoint

post/api/v1/tools/audio/read_tags

Request Body

Note: This endpoint should use formData() for the request body

filebinary audio file

Generate Image

generates an image using openai dall-e

Endpoint

post/api/v1/tools/image_generator_original

Request Body

promptstring (<=4000 chars)

Generator Image

image generation via replicate

Endpoint

post/api/v1/tools/image_generator

Request Body

Note: This endpoint should use formData() for the request body

text_promptstring (optional)

images_promptarray of image files (optional)

Image To SVG

vectorizes an image to svg (recraft vectorize)

Endpoint

post/api/v1/tools/image_to_svg

Request Body

Note: This endpoint should use formData() for the request body

images_promptarray of image files

is_make_squarebool (optional)

precisionnumber (optional)

Image Remove Background

removes background from an image using replicate

Endpoint

post/api/v1/tools/remove_background

Request Body

Note: This endpoint should use formData() for the request body

filebinary image form field (<=2000kb)

Image Restore Face

restores face details in an image using replicate

Endpoint

post/api/v1/tools/restore_face

Request Body

Note: This endpoint should use formData() for the request body

filebinary image form field (<=2000kb)

Image Restore Resolution

enhances or upsamples an image using replicate api

Endpoint

post/api/v1/tools/restore_resolution

Request Body

Note: This endpoint should use formData() for the request body

filebinary image form field (<=2000kb)

Optimize SVG

optimizes svg text with precision and square options

Endpoint

post/api/v1/tools/svg_optimizer

Request Body

svg_textstring

precisionnumber (optional)

is_make_squarebool (optional)