Conversation

Create Conversation
Get Conversations By Object
Get Conversation
Update Conversation
Delete Conversation

POST /api/v1/core/conversationCreate a new conversation 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

Body text of the entry.

string

ID of the parent object, or null for a top-level object.

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/conversation" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "asset",
    "object_id": "de895cb6-3810-58a4-937a-f54da5201882",
    "content": "Can we confirm the refresh schedule for this table?",
    "parent_id": null
  }'

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",
  "content": "Can we confirm the refresh schedule for this table?",
  "parent_id": null
}

Response

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

POST /api/v1/core/conversation/{category}/{objectId}Returns the conversation threads attached to an object, such as an asset, domain or term. 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.

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/conversation/{category}/{objectId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "pagination": {
      "page": 1,
      "pageSize": 20
    },
    "search": "",
    "filters": [],
    "sorting": []
  }'

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": []
}

Response

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

GET /api/v1/core/conversation/{conversationId}Get a conversation by its ID.Path Parameters

string

required

ID of the conversation.

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 GET "https://<your-workspace>.prizmdata.ai/api/v1/core/conversation/{conversationId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

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

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

string

Body text of the entry.

Path Parameters

string

required

ID of the conversation.

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/conversation/{conversationId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Confirmed - refreshed daily at 02:00 UTC."
  }'

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

Request body

{
  "content": "Confirmed - refreshed daily at 02:00 UTC."
}

Response

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

DELETE /api/v1/core/conversation/{conversationId}Delete a conversation by its ID.Path Parameters

string

required

ID of the conversation.

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/conversation/{conversationId}" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Response

{
  "success": true,
  "message": "Delete a conversation 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