Graphon Engine

Overview

Learn how to set up and use the Graphon search and query engine

Graphon Engine is the search and query engine that powers Graphon Cloud and Graphon Enterprise. This guide introduces its core concepts and shows you how to deploy, set up, and use it.

What is Graphon Engine?

Graphon Engine is a collection of services and storage components that run together as a cluster. The REST API receives requests. The Blob Indexer uses GPUs to understand each file and find connections between files. The Query Engine runs Search, Answer, and Research. A database holds metadata, a blob cache speeds up data access, and blob storage keeps file content. Blobs are stored units of file data.

The main components of a Graphon Engine cluster and how they connect.

How Graphon Engine organizes your data

Cluster

graphon.example.com

https://graphon.example.com

Namespace

acme-corp

https://graphon.example.com/namespaces/acme-corp

Collection

incident-logs

https://graphon.example.com/namespaces/acme-corp/collections/incident-logs

File

/incidents/checkout.txt

TXT

File

/incidents/payment-outage.pdf

PDF

File

/screenshots/checkout-errors.png

PNG

File

/recordings/war-room-call.mp4

MP4
Collection

policies

https://graphon.example.com/namespaces/acme-corp/collections/policies

File

/security/access-control.pdf

PDF

File

/hr/employee-handbook.pdf

PDF

File

/it/acceptable-use.md

MD

File

/diagrams/network-zones.png

PNG
Namespace

northwind-corp

https://graphon.example.com/namespaces/northwind-corp

Collection

research

https://graphon.example.com/namespaces/northwind-corp/collections/research

File

/interviews/customer-01.mp3

MP3

File

/surveys/2026-q3-results.json

JSON

File

/notes/pricing-findings.md

MD

File

/papers/market-sizing.pdf

PDF
Collection

reports

https://graphon.example.com/namespaces/northwind-corp/collections/reports

File

/2026/q3/summary.pdf

PDF

File

/2026/q3/revenue.csv

CSV

File

/2026/q3/regional-analysis.txt

TXT

File

/charts/q3-growth.png

PNG
How a cluster organizes data: namespaces contain collections, and collections contain files.

A cluster is one Engine deployment with its own base URL. It contains namespaces, which isolate tenants. A tenant is a customer or application whose data must stay separate. Each namespace contains collections. A collection holds the files that one Search or Answer request can use. Answer can respond to a question even when the facts are spread across many files.

For example, the acme-corp namespace contains an incident-logs collection. Add incident reports, screenshots, or recordings to that collection. Search can locate an incident. Answer can explain its cause from several reports and cite each source.

A file has an ID, a logical path, a source, metadata, and a processing status. Its path might be /incidents/checkout.txt. Its source supplies the content. The path organizes the collection and does not have to match the source location.

GET https://graphon.example.com/namespaces/acme-corp/collections/incident-logs/files/fil_01J8Z3K4N5P6Q7R8S9T0V1W2X3

GET /namespaces/acme-corp/collections/incident-logs/files/fil_01J8Z3K4N5P6Q7R8S9T0V1W2X3 HTTP/1.1
Host: graphon.example.com
Authorization: Bearer <GRAPHON_ENGINE_API_KEY>

200 OK

{
  "id": "fil_01J8Z3K4N5P6Q7R8S9T0V1W2X3",
  "path": "/incidents/checkout.txt",
  "status": "ready",
  "stage": null,
  "source": {
    "type": "inline",
    "content_type": "text/plain",
    "bytes": 118
  },
  "metadata": {
    "environment": "production",
    "service": "checkout"
  },
  "created_at": "2026-10-06T12:00:00Z",
  "updated_at": "2026-10-06T12:01:00Z"
}

Adding files to a collection

Add a file with one request to the collection’s files endpoint. The request names the file’s path and its source. The source tells Engine where the file bytes come from.

Send text inline, upload the bytes, or give a cloud storage URI. Engine adds the file to the collection named in the request path, then moves it from pending to indexing to ready.
SourceHow Engine gets the bytes

inline

The request body holds the text. Use it for small text files. The whole body must fit in 1,048,576 bytes.

upload

Engine returns a signed upload.url. PUT the file bytes to that URL before upload.expires_at.

uri

Engine reads the object from your cloud storage, such as a gs:// URI. Call /info to see the URI schemes that your cluster supports.

POST https://graphon.example.com/namespaces/acme-corp/collections/incident-logs/files

POST /namespaces/acme-corp/collections/incident-logs/files HTTP/1.1
Host: graphon.example.com
Authorization: Bearer <GRAPHON_ENGINE_API_KEY>
Content-Type: application/json
Idempotency-Key: checkout-txt-1

{
  "path": "/incidents/checkout.txt",
  "source": {
    "type": "inline",
    "content_type": "text/plain",
    "text": "Checkout stalled because the service exhausted its connection pool. Increase the pool size before the next deployment."
  }
}

Engine replies right away. Inline and URI requests return 202 Accepted. An upload returns 201 Created with the upload URL. Each response holds the new file and a job. Save their IDs.

Processing continues after the response. The file starts as pending while it waits for its bytes or an indexer. During indexing, GPUs understand the file’s contents and link it to related files. A ready file can appear in Search and Answer. If processing stops, the file is failed. Read its error and its job.

Engine sends a file.status_changed event at each change. Jobs and events explain how to track completion.

Searching and answering from collections

Search ranks the files in one collection. Each result has a rank, path, score, and the spans that matched.
Answer responds to a natural-language question from several files in one collection. Each citation marker in the answer maps to a source.
UseResultExample

Search

Ranked files or passages, scores, and spans.

Find reports about checkout connection failures.

Answer

An answer grounded in the collection, with citations.

Why did checkout stall, and what should we change?

Research

The same answer from a run that works on its own. Read it when it ends.

Find every incident in which checkout ran out of database connections.

Each operation addresses one collection. Choose Search to build a results interface. Choose Answer to answer a question from the files. Choose Research for a long question that should not hold a connection open.

Control who can retrieve

An API key authorizes your application. Its scope identifies the namespace or collections it can reach. Its actions identify the operations it can perform. Authentication explains the complete contract.

For per-user retrieval, enable access control on a collection. Your application authenticates each person and sends their principals: exact user and group names. Engine applies access rules before content can enter Search results or answers. See Principals and access rules.

Start building

Use the Get started guide for a complete HTTP walkthrough with inline text. It requires a reachable cluster and a cluster API key. No external storage account is needed.

Read Concepts for the data model. Use the API reference for request fields, response fields, errors, and examples. Each example uses https://engine.example.com; replace it with your cluster URL.

Was this page helpful?
View as Markdown