Skip to main content
POST
/
v1
/
views
Create a view
curl --request POST \
  --url http://localhost:8000/v1/views \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_type": "<string>",
  "name": "<string>",
  "fields": [
    "<string>"
  ],
  "description": "<string>",
  "is_default": false
}
'
{
  "view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "document_type": "<string>",
  "name": "<string>",
  "fields": [
    "<string>"
  ],
  "is_default": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: dk_test_ or dk_live_

Body

application/json

Request for creating a new view (POST /v1/views).

​
document_type
string
required

Document type code this view applies to

​
name
string
required

View name

Required string length: 1 - 100
​
fields
string[]
required

List of field names to include

Minimum array length: 1
​
description
string | null

Optional description

Maximum string length: 500
​
is_default
boolean
default:false

Whether this is the default view

Response

Created view

Tenant view response.

Views define which fields from extracted data are returned when querying documents.

​
view_id
string<uuid>
required

Unique identifier for the view

​
document_type
string
required

Document type code this view applies to

​
name
string
required

View name (e.g., 'accounting', 'compliance')

​
fields
string[]
required

List of field names included in this view

​
is_default
boolean
required

Whether this is the default view for this document type

​
created_at
string<date-time>
required

View creation timestamp (ISO 8601)

​
updated_at
string<date-time>
required

Last modification timestamp (ISO 8601)

​
description
string | null

Optional description of the view's purpose