Document

POST /api/v1/core/documentCreate a new asset document in the database.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

string

Object category, for example asset.

string

ID of the object the entry is attached to.

string

Fully qualified name of the object the entry is attached to.

string

Display name.

string

Body text of the entry.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

The endpoint’s response payload.

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/core/document" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "asset",
    "object_id": "de895cb6-3810-58a4-937a-f54da5201882",
    "object_qualified_name": "ANALYTICS.PUBLIC.ORDERS",
    "name": "Orders table overview",
    "content": "Contains one row per completed customer order."
  }'

Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.

Request body

{
  "category": "asset",
  "object_id": "de895cb6-3810-58a4-937a-f54da5201882",
  "object_qualified_name": "ANALYTICS.PUBLIC.ORDERS",
  "name": "Orders table overview",
  "content": "Contains one row per completed customer order."
}

Response

{
  "success": true,
  "message": "Create a new asset document in the database.",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

POST /api/v1/core/document/latestGet latest documents with pagination, sorting, filtering and search.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

object

Page settings.

integer

Page number, starting at 1.

integer

Records per page.

string

Free-text search term.

array

Array of filter objects.

array

Array of sort instructions.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

object[]

string

Example: "1ef6040e-eb73-5a1d-8620-f896719b6796".

string

Example: "tag".

string

Example: "1f162c5d-cd84-5d31-a775-b54dd2a1496b".

string

Example: "governance_tag".

string

Example: "document".

object[]

string

Example: "2026-09-20T05:07:49.872544Z".

string

Example: "8095dcf8-1bfd-5340-8f37-496385d8fa68".

integer

Example: 3.

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/core/document/latest" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "pagination": {
      "page": 1,
      "pageSize": 20
    },
    "search": "",
    "filters": [],
    "sorting": []
  }'

Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.

Request body

{
  "pagination": {
    "page": 1,
    "pageSize": 20
  },
  "search": "",
  "filters": [],
  "sorting": []
}

Response

{
  "success": true,
  "message": "Get latest documents with pagination, sorting, filtering and search.",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "data": [
      {
        "id": "1ef6040e-eb73-5a1d-8620-f896719b6796",
        "category": "tag",
        "object_id": "1f162c5d-cd84-5d31-a775-b54dd2a1496b",
        "object_qualified_name": "governance_tag",
        "name": "document",
        "content": [],
        "created_at": "2026-09-20T05:07:49.872544Z",
        "created_by": "8095dcf8-1bfd-5340-8f37-496385d8fa68"
      }
    ],
    "total_count": 3
  }
}

POST /api/v1/core/document/{category}/{objectId}Returns the documentation entries attached to an object, such as an asset. category is the object type and objectId is its ID.Request Body

object

Page settings.

integer

Page number, starting at 1.

integer

Records per page.

string

Free-text search term.

array

Array of filter objects.

array

Array of sort instructions.

string

ID of the object the entry is attached to.

string

Fully qualified name of the object the entry is attached to.

Path Parameters

string

required

Category of the object (for example the entity type the record is attached to).

string

required

ID of the object the record belongs to.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

The endpoint’s response payload.

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/core/document/{category}/{objectId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "pagination": {
      "page": 1,
      "pageSize": 20
    },
    "search": "",
    "filters": [],
    "sorting": [],
    "object_id": "de895cb6-3810-58a4-937a-f54da5201882",
    "object_qualified_name": "ANALYTICS.PUBLIC.ORDERS"
  }'

This request body matches the payload the Prizm web app sends for this endpoint. IDs and values are placeholders.

Request body

{
  "pagination": {
    "page": 1,
    "pageSize": 20
  },
  "search": "",
  "filters": [],
  "sorting": [],
  "object_id": "de895cb6-3810-58a4-937a-f54da5201882",
  "object_qualified_name": "ANALYTICS.PUBLIC.ORDERS"
}

Response

{
  "success": true,
  "message": "Get Documentations By Object",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

GET /api/v1/core/document/{documentId}Get a document by its ID.Path Parameters

string

required

ID of the document.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

string

Example: "1ef6040e-eb73-5a1d-8620-f896719b6796".

string

Example: "tag".

string

Example: "1f162c5d-cd84-5d31-a775-b54dd2a1496b".

string

Example: "governance_tag".

string

Example: "document".

object[]

string

Example: "block-a1b2c3d4e5f60718293a4b5c6d7e8f90".

string

Example: "heading2".

string

Example: "Acme Financial Policy".

integer

Example: 0.

string

Example: "inherit".

string

Example: "transparent".

string

Example: "2026-09-20T05:07:49.872544Z".

string

Example: "8095dcf8-1bfd-5340-8f37-496385d8fa68".

Example

curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/core/document/{documentId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

{
  "success": true,
  "message": "Get a document by its ID.",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "id": "1ef6040e-eb73-5a1d-8620-f896719b6796",
    "category": "tag",
    "object_id": "1f162c5d-cd84-5d31-a775-b54dd2a1496b",
    "object_qualified_name": "governance_tag",
    "name": "document",
    "content": [
      {
        "id": "block-a1b2c3d4e5f60718293a4b5c6d7e8f90",
        "type": "heading2",
        "content": "​Acme Financial Policy​",
        "position": 0,
        "textColor": "inherit",
        "backgroundColor": "transparent"
      }
    ],
    "created_at": "2026-09-20T05:07:49.872544Z",
    "created_by": "8095dcf8-1bfd-5340-8f37-496385d8fa68"
  }
}

POST /api/v1/core/document/listGet all documents with pagination, sorting, filtering and search.Request Body

object

integer

Example: 1.

integer

Example: 10.

object[]

string

Example: "".

boolean

Example: false.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

object[]

string

Example: "1ef6040e-eb73-5a1d-8620-f896719b6796".

string

Example: "tag".

string

Example: "1f162c5d-cd84-5d31-a775-b54dd2a1496b".

string

Example: "governance_tag".

string

Example: "document".

object[]

string

Example: "block-a1b2c3d4e5f60718293a4b5c6d7e8f90".

string

Example: "heading2".

string

Example: "Acme Financial Policy".

integer

Example: 0.

string

Example: "inherit".

string

Example: "transparent".

string

Example: "2026-09-20T05:07:49.872544Z".

string

Example: "8095dcf8-1bfd-5340-8f37-496385d8fa68".

integer

Example: 3.

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/core/document/list" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "pagination": {
    "page": 1,
    "pageSize": 10
  },
  "sorting": [],
  "filters": [],
  "search": "",
  "export": false
}'

Response

{
  "success": true,
  "message": "Get all documents with pagination, sorting, filtering and search.",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "data": [
      {
        "id": "1ef6040e-eb73-5a1d-8620-f896719b6796",
        "category": "tag",
        "object_id": "1f162c5d-cd84-5d31-a775-b54dd2a1496b",
        "object_qualified_name": "governance_tag",
        "name": "document",
        "content": [
          {
            "id": "block-a1b2c3d4e5f60718293a4b5c6d7e8f90",
            "type": "heading2",
            "content": "​Acme Financial Policy​",
            "position": 0,
            "textColor": "inherit",
            "backgroundColor": "transparent"
          }
        ],
        "created_at": "2026-09-20T05:07:49.872544Z",
        "created_by": "8095dcf8-1bfd-5340-8f37-496385d8fa68"
      }
    ],
    "total_count": 3
  }
}

PUT /api/v1/core/document/{documentId}Update an existing document in the database.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

string

Display name.

string

Body text of the entry.

Path Parameters

string

required

ID of the document.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

The endpoint’s response payload.

Example

curl -X PUT "https://<your-workspace>.prizmdata.ai/api/v1/core/document/{documentId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Orders table overview",
    "content": "Updated: now includes refunds."
  }'

Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.

Request body

{
  "name": "Orders table overview",
  "content": "Updated: now includes refunds."
}

Response

{
  "success": true,
  "message": "Update an existing document in the database.",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

DELETE /api/v1/core/document/{documentId}Delete a document by its ID.Path Parameters

string

required

ID of the document.

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

The endpoint’s response payload.

Example

curl -X DELETE "https://<your-workspace>.prizmdata.ai/api/v1/core/document/{documentId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

{
  "success": true,
  "message": "Delete a document by its ID.",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {}
}

Get Started

Core

Metrics

Schedule

Notification

Integrations

Governance

Logging