Skip to main content
POST
/
v1
/
tables
/
{table_id}
/
validate
Validate Table
curl --request POST \
  --url https://api.retab.com/v1/tables/{table_id}/validate \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "required_columns": [],
  "columns": {},
  "unique": []
}
'
{
  "table_id": "<string>",
  "diagnostics": [],
  "has_errors": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.retab.com/llms.txt

Use this file to discover all available pages before exploring further.

Validate table shape and column rules against the current CSV snapshot.
Python
result = client.tables.validate(
    table_id="tbl_123",
    required_columns=["countrycode"],
)
TypeScript
const result = await client.tables.validate("tbl_123", ["countrycode"]);
Go
result, err := client.Tables.Validate(ctx, "tbl_123", &retab.TablesValidateParams{
  RequiredColumns: []string{"countrycode"},
})
Java
// Validate table requirements with the Retab Java client.
cURL
curl -X POST https://api.retab.com/v1/tables/tbl_123/validate \
  -H "Api-Key: $RETAB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"required_columns":["countrycode"]}'

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
table_id
string
required

Body

application/json
​
required_columns
string[]
​
columns
Columns · object
​
unique
string[][]

Response

Successful Response

​
table_id
string
required
​
diagnostics
WorkflowTableValidationDiagnostic · object[]
​
has_errors
boolean
default:false