HTTP API

Knowledge graph

Knowledge graph indexing, exploration, curation, job control, and export endpoints.

Delete an effective graph identity without deleting evidence

POST/api/knowledge-spaces/{knowledgeSpaceId}/graph/curations/suppressions

Path Parameters

knowledgeSpaceId*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

*/*

curl -X POST "https://example.com/api/knowledge-spaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/graph/curations/suppressions" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "namespace": {    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "workspace": "string",    "collection": "string"  },  "entity": {    "kind": "ENTITY",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  },  "name": "string",  "type": "string",  "description": "string",  "governingEvidence": {    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "knowledgeAssetId": "0e21085d-79c9-44f9-b229-2554c2bd0165",    "sourceRevisionId": "307572f1-3846-4c73-a8d9-3b07cde2b356",    "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",    "aclSnapshotId": "19aeaaa7-c6ad-4f73-bd6d-6a355de9c0e9",    "aclGeneration": 0,    "chunk": true  },  "provenance": {    "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",    "authorizationModelId": "string",    "aclGeneration": 0,    "curatedAt": "2019-08-24T14:15:22Z",    "reason": "string"  }}

Create or edit a governed graph relation

POST/api/knowledge-spaces/{knowledgeSpaceId}/graph/curations/relations

Path Parameters

knowledgeSpaceId*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

*/*

curl -X POST "https://example.com/api/knowledge-spaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/graph/curations/relations" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "namespace": {    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "workspace": "string",    "collection": "string"  },  "entity": {    "kind": "ENTITY",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  },  "name": "string",  "type": "string",  "description": "string",  "governingEvidence": {    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "knowledgeAssetId": "0e21085d-79c9-44f9-b229-2554c2bd0165",    "sourceRevisionId": "307572f1-3846-4c73-a8d9-3b07cde2b356",    "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",    "aclSnapshotId": "19aeaaa7-c6ad-4f73-bd6d-6a355de9c0e9",    "aclGeneration": 0,    "chunk": true  },  "provenance": {    "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",    "authorizationModelId": "string",    "aclGeneration": 0,    "curatedAt": "2019-08-24T14:15:22Z",    "reason": "string"  }}

Create or edit a governed graph entity

POST/api/knowledge-spaces/{knowledgeSpaceId}/graph/curations/entities

Path Parameters

knowledgeSpaceId*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

*/*

curl -X POST "https://example.com/api/knowledge-spaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/graph/curations/entities" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "namespace": {    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "workspace": "string",    "collection": "string"  },  "entity": {    "kind": "ENTITY",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  },  "name": "string",  "type": "string",  "description": "string",  "governingEvidence": {    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "knowledgeAssetId": "0e21085d-79c9-44f9-b229-2554c2bd0165",    "sourceRevisionId": "307572f1-3846-4c73-a8d9-3b07cde2b356",    "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",    "aclSnapshotId": "19aeaaa7-c6ad-4f73-bd6d-6a355de9c0e9",    "aclGeneration": 0,    "chunk": true  },  "provenance": {    "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",    "authorizationModelId": "string",    "aclGeneration": 0,    "curatedAt": "2019-08-24T14:15:22Z",    "reason": "string"  }}

Merge graph identities through a reversible alias

POST/api/knowledge-spaces/{knowledgeSpaceId}/graph/curations/aliases

Path Parameters

knowledgeSpaceId*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

*/*

curl -X POST "https://example.com/api/knowledge-spaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/graph/curations/aliases" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "namespace": {    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "workspace": "string",    "collection": "string"  },  "entity": {    "kind": "ENTITY",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  },  "name": "string",  "type": "string",  "description": "string",  "governingEvidence": {    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "knowledgeAssetId": "0e21085d-79c9-44f9-b229-2554c2bd0165",    "sourceRevisionId": "307572f1-3846-4c73-a8d9-3b07cde2b356",    "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",    "aclSnapshotId": "19aeaaa7-c6ad-4f73-bd6d-6a355de9c0e9",    "aclGeneration": 0,    "chunk": true  },  "provenance": {    "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",    "authorizationModelId": "string",    "aclGeneration": 0,    "curatedAt": "2019-08-24T14:15:22Z",    "reason": "string"  }}

Export only graph evidence visible to the current user

GET/api/knowledge-spaces/{knowledgeSpaceId}/graph/export

Path Parameters

knowledgeSpaceId*string
Formatuuid

Query Parameters

format?string
Default"JSON"

Value in

  • "JSON"
  • "CSV"
  • "MARKDOWN"
  • "TEXT"

Header Parameters

X-Request-Id?string

Response Body

*/*

curl -X GET "https://example.com/api/knowledge-spaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/graph/export"
"string"

Read a bounded permission-filtered graph view

GET/api/knowledge-spaces/{knowledgeSpaceId}/graph/explorer

Path Parameters

knowledgeSpaceId*string
Formatuuid

Query Parameters

q?string
entityLimit?integer
Formatint32
maxDepth?integer
Formatint32

Response Body

*/*

curl -X GET "https://example.com/api/knowledge-spaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/graph/explorer"
{  "knowledgeSpaceId": "11ef9487-895c-48ad-a581-df51ab86e43b",  "authorizationGeneration": 0,  "canCurate": true,  "entities": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "type": "string",      "description": "string",      "citationChunkIds": [        "a6d76241-7fc4-4517-87e2-90d84f96fa8f"      ],      "governingEvidence": {        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",        "knowledgeAssetId": "0e21085d-79c9-44f9-b229-2554c2bd0165",        "sourceRevisionId": "307572f1-3846-4c73-a8d9-3b07cde2b356",        "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",        "aclSnapshotId": "19aeaaa7-c6ad-4f73-bd6d-6a355de9c0e9",        "aclGeneration": 0,        "chunk": true      }    }  ],  "relations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "sourceEntityId": "919f567b-165b-4d91-b8e9-824c276b9aa4",      "targetEntityId": "ffcbe7bd-b93a-4630-87c7-2d0f166f5fc1",      "type": "string",      "description": "string",      "weight": 0.1,      "keywords": [        "string"      ],      "citationChunkIds": [        "a6d76241-7fc4-4517-87e2-90d84f96fa8f"      ],      "governingEvidence": {        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",        "knowledgeAssetId": "0e21085d-79c9-44f9-b229-2554c2bd0165",        "sourceRevisionId": "307572f1-3846-4c73-a8d9-3b07cde2b356",        "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",        "aclSnapshotId": "19aeaaa7-c6ad-4f73-bd6d-6a355de9c0e9",        "aclGeneration": 0,        "chunk": true      }    }  ],  "truncated": true}

Reverse a graph curation record

DELETE/api/knowledge-spaces/{knowledgeSpaceId}/graph/curations/{curationId}

Path Parameters

knowledgeSpaceId*string
Formatuuid
curationId*string
Formatuuid

Query Parameters

authorizationGeneration*integer
Formatint64
reason*string

Response Body

curl -X DELETE "https://example.com/api/knowledge-spaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/graph/curations/497f6eca-6276-4993-bfeb-53cbbbba6f08?authorizationGeneration=0&reason=string"
Empty

Last updated on

Assistant

Permission-aware conversations and assistant tool endpoints.

Search and catalog

Permission-aware knowledge search, catalog, and citation-content endpoints.