Skip to main content
POST
Create Database

Authorizations

X-API-Key
string
header
required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

Authorization
string
header
required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Body

application/json

Request to create a new document file entry.

name
string
required

Document name

credential_id
string<uuid> | null

Credential ID for PostgreSQL databases

database_type
enum<string>
default:csv

Type of database

Available options:
csv,
postgres
description
string | null

Document description

table_name
string | null

Table name for PostgreSQL databases

Response

Successful Response

Response for document file operations.

created_at
string<date-time>
required

Creation timestamp

database_type
enum<string>
required

Type of database

Available options:
csv,
postgres
id
string<uuid>
required

Document file ID

name
string
required

Document name

status
string
required

File status

updated_at
string<date-time>
required

Last update timestamp

current_file_id
string<uuid> | null

Current file ID in bucket

current_table_name
string | null

Current dataset name

description
string | null

Document description

modified_by
string
default:system

User ID (UUID string) or 'system' of the actor who last modified the file. For users, stores UUID string; for integrations, stores type value; for system changes, stores 'system'.

revision_count
integer
default:0

Number of file revisions

total_rows
integer
default:0

Total rows in current file