Create ingest

Reads a source and records what it states, through the same admission as assert.

POST /v1/graph/ingest

Addresshttps://api.hanzo.ai/v1/graph/ingest
MethodPOST
OperationgraphIngest
AuthAuthorization: Bearer $HANZO_API_KEY

Reads a source and records what it states, through the same admission as assert.

Each assertion's evidence is the section that stated it, <source>#<section>, so the same source at the same at records one set of rows however often it is delivered. What extract reports refused is not recorded; it is counted as refused, with its reason, in the order the document states it. A source stating no relation is refused whole.

Time: at is the valid time of every assertion recorded, which an as_of read is bounded by; each becomes knowable at the write, so a read with an earlier as_known does not see it.

Request

4 fields, body application/json (required).

FieldInTypeRequiredDescription
atbodystring—At is when what the source says was so, RFC 3339.
sourcebodystringyesSource names where the text came from — a URL, a document id, a page title.
subjectbodystring—Subject is the entity the text is about before any heading names one.
textbodystringyesText is the document.

Response

StatusBodyMeaning
200graph.graphAssertOutok
defaultproblem-detailsrefused

200 body — 4 fields.

FieldInTypeAlwaysDescription
duplicatebodyinteger (int64)—Duplicate is how many members this plane already held.
reasonsbodystring[]—Reasons names why each refused member was refused, in the order sent.
recordedbodyinteger (int64)—Recorded is how many members became new rows.
refusedbodyinteger (int64)—Refused is how many members were turned away — a missing entity, a timestamp that is not RFC 3339, a confidence outside [0,1], a relation whose declared domain or range the entity's type does not meet, or a declaration from a caller who is not an admin of the organization.

Failure carries the platform error shape — see Errors.

Examples

hanzo graph ingest
import { Configuration, GraphApi } from 'hanzoai';

const api = new GraphApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.graphIngest({ source: "<source>", text: "<text>" });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import GraphApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = GraphApi(client).graph_ingest(source="<source>", text="<text>")
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.GraphAPI.GraphIngest(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, graph_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = graph_api::graph_ingest(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.GraphApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new GraphApi(client).graphIngest();
curl -X POST https://api.hanzo.ai/v1/graph/ingest \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "source": "<source>",
       "text": "<text>"
     }'

Tool graph, op graphIngest — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "graph",
         "arguments": {
           "op": "graphIngest",
           "input": {
             "source": "<source>",
             "text": "<text>"
           }
         }
       }
     }'

Graph API · All Hanzo APIs · Interactive reference

Was this page useful?