Knowledge
List Knowledge Activity
Header Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/activity"[
{}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Dispute Claim
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/claims/497f6eca-6276-4993-bfeb-53cbbbba6f08/dispute"{
"property1": "string",
"property2": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Endorse Claim
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/claims/497f6eca-6276-4993-bfeb-53cbbbba6f08/endorse"{
"property1": "string",
"property2": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Resolve Comment
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/comments/497f6eca-6276-4993-bfeb-53cbbbba6f08/resolve"{
"property1": "string",
"property2": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Create Or Resume Curator Session
Header Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/curator/session"{}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List Documents
Query Parameters
Search by title or content
Filter by tag name(s)
Restrict tag name filters to a namespace
Filter by tag id(s)
"any""any" | "all"501 <= value <= 10000 <= valueHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/documents"{
"hasNext": true,
"items": [
{
"clonedFromTemplateId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"disabled": false,
"id": "string",
"lastEditedBy": "string",
"parentDocumentId": "string",
"status": "string",
"tags": [
{
"attributes": {},
"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"namespace": "string",
"slug": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"tenantId": "string",
"title": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"limit": 0,
"nextOffset": 0,
"offset": 0,
"total": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Create Document
Header Parameters
Cookie Parameters
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/documents" \ -H "Content-Type: application/json" \ -d '{ "content": {}, "title": "string" }'{
"clonedFromTemplateId": "string",
"content": {},
"contentText": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"disabled": false,
"id": "string",
"lastEditedBy": "string",
"parentDocumentId": "string",
"status": "string",
"tags": [
{
"attributes": {},
"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"namespace": "string",
"slug": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"tenantId": "string",
"title": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Document
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"clonedFromTemplateId": "string",
"content": {},
"contentText": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"disabled": false,
"id": "string",
"lastEditedBy": "string",
"parentDocumentId": "string",
"status": "string",
"tags": [
{
"attributes": {},
"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"namespace": "string",
"slug": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"tenantId": "string",
"title": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Update Document
Path Parameters
uuidHeader Parameters
Cookie Parameters
Request Body
application/json
Response Body
application/json
application/json
curl -X PATCH "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{
"clonedFromTemplateId": "string",
"content": {},
"contentText": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"disabled": false,
"id": "string",
"lastEditedBy": "string",
"parentDocumentId": "string",
"status": "string",
"tags": [
{
"attributes": {},
"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"namespace": "string",
"slug": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"tenantId": "string",
"title": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Delete Document
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
curl -X DELETE "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Suggest Changeset
Path Parameters
uuidHeader Parameters
Cookie Parameters
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/changesets/suggest" \ -H "Content-Type: application/json" \ -d '{ "sectionFrom": 0, "sectionText": "string", "sectionTo": 0 }'{
"changeset": {
"createdAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"itemCount": 0,
"proposedEventId": "739c2f67-0578-48e7-9ee8-cf667c07cb88",
"proposerType": "string",
"proposerUserId": "62b86409-fac8-4e68-b306-9cdf48f52616",
"rationale": "string",
"resolvedAt": "2019-08-24T14:15:22Z",
"resolvedBy": "14b2aa2a-efb0-4ef1-9ffc-3025efbd2222",
"resolvedEventId": "812b5d17-6c80-4776-a21b-73c2932f1589",
"reviewNote": "string",
"status": "proposed",
"threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
"title": "string",
"turnId": "7513f73d-27ec-455d-85b7-7bd021b4dccf",
"updatedAt": "2019-08-24T14:15:22Z",
"workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
},
"items": [
{
"assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
"assetKind": "knowledge_document",
"baseContentSha256": "string",
"baseText": "string",
"baseVersion": 0,
"baseVersionId": "238d56e0-9ec7-4ebf-bfb2-e487b4bc769c",
"changesetId": "7df26743-2060-4d41-a94a-946846cd7422",
"contentFormat": "string",
"createdAt": "2019-08-24T14:15:22Z",
"diffStats": {},
"diffUnified": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"operation": "create",
"ordinal": 0,
"proposedContentSha256": "string",
"proposedPayload": {},
"proposedText": "string",
"resultVersion": 0,
"resultVersionId": "5bdef736-5d13-4b91-8666-e0cb14973657",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Document Claims
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/claims"[
{
"confidence": 0,
"contradictionCount": 0,
"effectiveConfidence": 0,
"id": "string",
"spanFrom": 0,
"spanTo": 0,
"text": "string"
}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Extract Claims Now
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/claims/extract"{
"property1": "string",
"property2": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List Comments
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/comments"[
{
"anchorFrom": 0,
"anchorText": "string",
"anchorTo": 0,
"authorName": "string",
"authorUserId": "string",
"body": "string",
"createdAt": "2019-08-24T14:15:22Z",
"documentId": "string",
"id": "string",
"parentCommentId": "string",
"resolvedAt": "2019-08-24T14:15:22Z"
}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Create Comment
Path Parameters
uuidHeader Parameters
Cookie Parameters
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/comments" \ -H "Content-Type: application/json" \ -d '{ "body": "string" }'{
"anchorFrom": 0,
"anchorText": "string",
"anchorTo": 0,
"authorName": "string",
"authorUserId": "string",
"body": "string",
"createdAt": "2019-08-24T14:15:22Z",
"documentId": "string",
"id": "string",
"parentCommentId": "string",
"resolvedAt": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Document Contradictions
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/contradictions"[
{
"claimADocumentTitle": "string",
"claimAText": "string",
"claimBDocumentTitle": "string",
"claimBText": "string",
"confidence": 0,
"explanation": "string",
"relation": "string"
}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Fork Document
Path Parameters
uuidHeader Parameters
Cookie Parameters
Request Body
application/json
Body for POST /documents/:id/fork — currently empty (future: fork label).
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/fork" \ -H "Content-Type: application/json" \ -d '{}'{
"clonedFromTemplateId": "string",
"content": {},
"contentText": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"disabled": false,
"id": "string",
"lastEditedBy": "string",
"parentDocumentId": "string",
"status": "string",
"tags": [
{
"attributes": {},
"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"namespace": "string",
"slug": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"tenantId": "string",
"title": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Upload Document Image
Path Parameters
uuidHeader Parameters
Cookie Parameters
Request Body
multipart/form-data
binaryResponse Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/images" \ -F file="string"{
"property1": "string",
"property2": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Document Image
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/images/string"null{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List Document Refs
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/refs"{
"docRefs": [
{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"documentId": "string",
"id": "string",
"label": "string",
"position": 0,
"targetDocumentId": "string",
"tenantId": "string"
}
],
"entityRefs": [
{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"documentId": "string",
"entityId": "string",
"id": "string",
"label": "string",
"position": 0,
"tenantId": "string"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Add Doc Ref
Path Parameters
uuidHeader Parameters
Cookie Parameters
Request Body
application/json
0Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/refs/documents" \ -H "Content-Type: application/json" \ -d '{ "targetDocumentId": "string" }'{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"documentId": "string",
"id": "string",
"label": "string",
"position": 0,
"targetDocumentId": "string",
"tenantId": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Remove Doc Ref
Path Parameters
uuiduuidHeader Parameters
Cookie Parameters
Response Body
application/json
curl -X DELETE "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/refs/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Add Entity Ref
Path Parameters
uuidHeader Parameters
Cookie Parameters
Request Body
application/json
0Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/refs/entities" \ -H "Content-Type: application/json" \ -d '{ "entityId": "string" }'{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"documentId": "string",
"entityId": "string",
"id": "string",
"label": "string",
"position": 0,
"tenantId": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Remove Entity Ref
Path Parameters
uuiduuidHeader Parameters
Cookie Parameters
Response Body
application/json
curl -X DELETE "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/refs/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List Document Sessions
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/sessions"[
{}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Create Knowledge Session
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/sessions"{
"property1": "string",
"property2": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List Document Tags
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/tags"{
"items": [
{
"attributes": {},
"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"namespace": "string",
"slug": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Set Document Tags
Path Parameters
uuidHeader Parameters
Cookie Parameters
Request Body
application/json
Response Body
application/json
application/json
curl -X PUT "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/tags" \ -H "Content-Type: application/json" \ -d '{}'{
"items": [
{
"attributes": {},
"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"namespace": "string",
"slug": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List Document Versions
Path Parameters
uuidQuery Parameters
201 <= value <= 100Header Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions"[
{
"authorAgentSpecId": "string",
"authorKind": "user",
"content": {},
"contentText": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"createdByName": "string",
"diffableText": "string",
"id": "string",
"sourceColorBucket": "string",
"sourceLabel": "string",
"sourceType": "string",
"summary": "string",
"title": "string",
"version": 0
}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Document Version
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/0"{
"authorAgentSpecId": "string",
"authorKind": "user",
"content": {},
"contentText": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"createdByName": "string",
"diffableText": "string",
"id": "string",
"sourceColorBucket": "string",
"sourceLabel": "string",
"sourceType": "string",
"summary": "string",
"title": "string",
"version": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Restore Document Version
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/0/restore"{
"clonedFromTemplateId": "string",
"content": {},
"contentText": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"disabled": false,
"id": "string",
"lastEditedBy": "string",
"parentDocumentId": "string",
"status": "string",
"tags": [
{
"attributes": {},
"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"namespace": "string",
"slug": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"tenantId": "string",
"title": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List Entities
Query Parameters
Search by name or slug
Filter by lifecycle status
251 <= value <= 10000 <= valueHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/entities"{
"hasNext": true,
"items": [
{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"definition": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "master_entity",
"name": "string",
"objectiveCadence": "daily",
"objectiveOwnerUserId": "c0f02024-f2e5-43f2-a58c-ed830253c720",
"objectiveTargetDirection": "higher_is_better",
"objectiveTargetValue": "string",
"parentObjectiveId": "f9c63857-12dd-44e1-8c01-2ea02152219c",
"slug": "string",
"status": "draft",
"stewardUserId": "831e2145-fdd2-4963-89ff-f7f8818795d6",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}
],
"limit": 0,
"nextOffset": 0,
"offset": 0,
"total": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Create Entity
Header Parameters
Cookie Parameters
Request Body
application/json
""length <= 8000The seven primitive kinds organized into four semantic layers.
Subject — the nouns the rest of the model hangs off: MASTER_ENTITY: a real-world business object (Company, Customer, Deal)
Event — the verbs: EVENT: something that happens involving entities (OrderPlaced, SyncRan)
Property — how to describe and slice subjects/events: ATTRIBUTE: categorical/temporal property (status, stage, region) MEASURE: calculated/aggregated value over events (revenue, count)
Aggregation — named slices and goal-bearing measures: SEGMENT: a constrained subset of a master entity OBJECTIVE: a measure plus target + owner + cadence (KPI generalization)
Vocabulary — defined terms that aren't first-class data: GLOSSARY_TERM: industry jargon, methodology, policy
"master_entity" | "event" | "attribute" | "measure" | "segment" | "objective" | "glossary_term"1 <= length <= 120"draft""draft" | "approved" | "deprecated"Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/entities" \ -H "Content-Type: application/json" \ -d '{ "kind": "master_entity", "name": "string" }'{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"definition": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "master_entity",
"name": "string",
"objectiveCadence": "daily",
"objectiveOwnerUserId": "c0f02024-f2e5-43f2-a58c-ed830253c720",
"objectiveTargetDirection": "higher_is_better",
"objectiveTargetValue": "string",
"parentObjectiveId": "f9c63857-12dd-44e1-8c01-2ea02152219c",
"slug": "string",
"status": "draft",
"stewardUserId": "831e2145-fdd2-4963-89ff-f7f8818795d6",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Find Entities By Binding
Query Parameters
The kind of data resource a canonical entity binds to.
Covers every form data takes in the platform — UUID-backed managed resources, external-warehouse natural keys, and physical tables in the tenant data schema (golden layer, task storage, workspace storage, materialized tool results).
"data_product_task" | "data_product_tool" | "workspace_chart" | "workspace" | "artifact" | "document" | "sync_table_binding" | "external_schema_table" | "external_schema_column" | "internal_data_table"Header Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/entities/by-binding?target_kind=data_product_task"{
"items": [
{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"definition": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "master_entity",
"name": "string",
"objectiveCadence": "daily",
"objectiveOwnerUserId": "c0f02024-f2e5-43f2-a58c-ed830253c720",
"objectiveTargetDirection": "higher_is_better",
"objectiveTargetValue": "string",
"parentObjectiveId": "f9c63857-12dd-44e1-8c01-2ea02152219c",
"slug": "string",
"status": "draft",
"stewardUserId": "831e2145-fdd2-4963-89ff-f7f8818795d6",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Entity
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"definition": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "master_entity",
"name": "string",
"objectiveCadence": "daily",
"objectiveOwnerUserId": "c0f02024-f2e5-43f2-a58c-ed830253c720",
"objectiveTargetDirection": "higher_is_better",
"objectiveTargetValue": "string",
"parentObjectiveId": "f9c63857-12dd-44e1-8c01-2ea02152219c",
"slug": "string",
"status": "draft",
"stewardUserId": "831e2145-fdd2-4963-89ff-f7f8818795d6",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Update Entity
Path Parameters
uuidHeader Parameters
Cookie Parameters
Request Body
application/json
Response Body
application/json
application/json
curl -X PATCH "https://loading/api/v1/knowledge/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"definition": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "master_entity",
"name": "string",
"objectiveCadence": "daily",
"objectiveOwnerUserId": "c0f02024-f2e5-43f2-a58c-ed830253c720",
"objectiveTargetDirection": "higher_is_better",
"objectiveTargetValue": "string",
"parentObjectiveId": "f9c63857-12dd-44e1-8c01-2ea02152219c",
"slug": "string",
"status": "draft",
"stewardUserId": "831e2145-fdd2-4963-89ff-f7f8818795d6",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Delete Entity
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
curl -X DELETE "https://loading/api/v1/knowledge/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List Entity Bindings
Path Parameters
uuidHeader Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/bindings"{
"items": [
{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"note": "string",
"refArtifactId": "3ee22991-0e40-4b9b-89a0-e37853f160f1",
"refConnectionId": "c6b691bd-2811-434b-a8da-1b987093634e",
"refDataProductTaskId": "23788a9c-d89a-4597-b979-83dd994eb14f",
"refDataProductToolId": "959beb0d-ef56-4029-9715-b6e10582b227",
"refDocumentId": "3d1faf84-ac8e-4e99-a7c1-22b08ddf0438",
"refExternalColumn": "string",
"refExternalSchema": "string",
"refExternalTable": "string",
"refInternalTableName": "string",
"refInternalTableScope": "shared",
"refSyncTableBindingId": "2d36b2ce-2250-41f9-a0e4-ae4654bb80d0",
"refWorkspaceChartId": "fb8695fa-a296-4ada-bfc9-412d58e19fa3",
"refWorkspaceId": "813e345c-4fbb-4217-a367-2fd917424eb9",
"targetKind": "data_product_task",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Create Entity Binding
Path Parameters
uuidHeader Parameters
Cookie Parameters
Request Body
application/json
The kind of data resource a canonical entity binds to.
Covers every form data takes in the platform — UUID-backed managed resources, external-warehouse natural keys, and physical tables in the tenant data schema (golden layer, task storage, workspace storage, materialized tool results).
"data_product_task" | "data_product_tool" | "workspace_chart" | "workspace" | "artifact" | "document" | "sync_table_binding" | "external_schema_table" | "external_schema_column" | "internal_data_table"Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/bindings" \ -H "Content-Type: application/json" \ -d '{ "targetKind": "data_product_task" }'{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"note": "string",
"refArtifactId": "3ee22991-0e40-4b9b-89a0-e37853f160f1",
"refConnectionId": "c6b691bd-2811-434b-a8da-1b987093634e",
"refDataProductTaskId": "23788a9c-d89a-4597-b979-83dd994eb14f",
"refDataProductToolId": "959beb0d-ef56-4029-9715-b6e10582b227",
"refDocumentId": "3d1faf84-ac8e-4e99-a7c1-22b08ddf0438",
"refExternalColumn": "string",
"refExternalSchema": "string",
"refExternalTable": "string",
"refInternalTableName": "string",
"refInternalTableScope": "shared",
"refSyncTableBindingId": "2d36b2ce-2250-41f9-a0e4-ae4654bb80d0",
"refWorkspaceChartId": "fb8695fa-a296-4ada-bfc9-412d58e19fa3",
"refWorkspaceId": "813e345c-4fbb-4217-a367-2fd917424eb9",
"targetKind": "data_product_task",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Update Entity Binding
Path Parameters
uuiduuidHeader Parameters
Cookie Parameters
Request Body
application/json
Response Body
application/json
application/json
curl -X PATCH "https://loading/api/v1/knowledge/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/bindings/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"note": "string",
"refArtifactId": "3ee22991-0e40-4b9b-89a0-e37853f160f1",
"refConnectionId": "c6b691bd-2811-434b-a8da-1b987093634e",
"refDataProductTaskId": "23788a9c-d89a-4597-b979-83dd994eb14f",
"refDataProductToolId": "959beb0d-ef56-4029-9715-b6e10582b227",
"refDocumentId": "3d1faf84-ac8e-4e99-a7c1-22b08ddf0438",
"refExternalColumn": "string",
"refExternalSchema": "string",
"refExternalTable": "string",
"refInternalTableName": "string",
"refInternalTableScope": "shared",
"refSyncTableBindingId": "2d36b2ce-2250-41f9-a0e4-ae4654bb80d0",
"refWorkspaceChartId": "fb8695fa-a296-4ada-bfc9-412d58e19fa3",
"refWorkspaceId": "813e345c-4fbb-4217-a367-2fd917424eb9",
"targetKind": "data_product_task",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Delete Entity Binding
Path Parameters
uuiduuidHeader Parameters
Cookie Parameters
Response Body
application/json
curl -X DELETE "https://loading/api/v1/knowledge/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/bindings/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List Entity Versions
Path Parameters
uuidQuery Parameters
501 <= value <= 100Header Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions"{
"items": [
{
"contentSha256": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"sourceType": "manual_edit",
"summary": "string",
"version": 0
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Knowledge Graph
Header Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/graph"{}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Regenerate Knowledge Graph
Header Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/graph/regenerate"{}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Start Knowledge Interview
Header Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/interview"{
"property1": "string",
"property2": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Preview Knowledge
Header Parameters
Cookie Parameters
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/preview" \ -H "Content-Type: application/json" \ -d '{ "query": "string" }'{
"claims": [
{
"claimText": "string",
"confidence": 0,
"contradictions": [
"string"
],
"effectiveConfidence": 0,
"entityId": "string",
"evidenceSummary": "string",
"sourceDocuments": [
{
"documentId": "string",
"documentTitle": "string"
}
],
"supportingClaims": [
"string"
]
}
],
"formattedPrompt": "string",
"memories": [
{
"content": "string",
"source": "string"
}
],
"totalClaims": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Trigger Knowledge Synthesis
Header Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/knowledge/seed"{
"property1": "string",
"property2": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Seed Status
Header Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/seed/status"{}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List All Knowledge Sessions
Query Parameters
201 <= value <= 50Header Parameters
Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/knowledge/sessions"[
{}
]{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}