Entities

Entity management endpoints

Entities are basic building blocks of a graph. They can be automatically extracted from a document and then added to a graph.

To automatically extract entities and relationships from a document, you can use the following endpoint:

MethodEndpointDescription
POST/documents/{id}/entities_and_relationshipsExtract entities and relationships from a document

To manage entities extracted from a document, you can use the following endpoints:

MethodEndpointDescription
GET/documents/{id}/entitiesGet entities for a document
GET/documents/{id}/entities/{id}Get an entity for a document
POST/documents/{id}/entitiesAdd entities to a document
POST/documents/{id}/entities/{id}Update an entity for a document
DELETE/documents/{id}/entities/{id}Delete an entity from a document

Once entities are added to a graph by a POST to “/graphs/{id}/{object_type}” endpoint, you can manage them using the following endpoints:

MethodEndpointDescription
GET/graphs/{id}/entitiesGet entities for a graph
GET/graphs/{id}/entities/{id}Get an entity for a graph
POST/graphs/{id}/entitiesAdd entities to a graph
POST/graphs/{id}/entities/{id}Update a specific entity on the graph
DELETE/graphs/{id}/entities/{id}Delete a specific entity from the graph
Was this page helpful?
Built with