API referenceindex
Index a content object into the graph
Ingests a content object into the graph, creating or resolving a content entity. If a content entity with the same URL already exists in the namespace, returns the existing entity ID (idempotent). Optionally connects the content entity to an existing entity.
Passing entity_id links the new content entity to that entity with an "about" relation and automatically triggers composition of the target entity's taste subspace in the background — so you normally do not need to call POST /entity/{id}/compose yourself after indexing linked content.
Authorization
ApiKeyAuth X-API-Key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/index" \ -H "Content-Type: application/json" \ -d '{ "content": { "url": "http://example.com", "type": "image" } }'{
"entity_id": "string",
"created": true
}{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}