Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
tableId
string
required
Minimum string length: 1
mode
enum<string>
default:create
Available options:
create,
rebuild,
drop
candidateKey
string
Minimum string length: 1
semantics
enum<string>
default:substring
Available options:
substring
provider
enum<string>
Available options:
pg_bigm,
pg_trgm
fieldIds
searchProbe
string
validationMode
enum<string>
default:real_ddl
Available options:
plan,
real_ddl
execute
boolean
default:false
allowLargeTableRewrite
boolean
default:false
requestId
string<uuid>

Reuse for retries; use a new ID for a newly reviewed operation

Response

200 - application/json

Successful response

dryRun
boolean
required
action
enum<string>
required
Available options:
dry_run,
queued,
failed
result
unknown
task
object
error
string
Last modified on September 15, 2026