Graphon API

API reference

The Graphon HTTP API: base URL, workspace paths, and how to make a first request.

Base URL

All Graphon API requests go to a single base URL. The API is versioned in the path.

Base URL

https://api.beta.graphon.ai/v1

Workspace paths

Machine routes live under /v1/workspaces/{workspaceId}. A key belongs to one workspace. Use it to manage members, invitations, and API keys, and to search a bucket or ask it a question.

Shape

  • The API uses JSON request and response bodies with camelCase fields.
  • List routes return an items array.
  • Errors use a consistent JSON shape. See Errors.

Make a first request

List the members in your workspace. Replace the example workspace ID with your own ID.

cURL

curl \
  --url "https://api.beta.graphon.ai/v1/workspaces/wspq7ws2np5l8z4/members" \
  --header "Authorization: Bearer $GRAPHON_API_KEY"

Storage

Buckets and objects live on the storage host, https://storage.beta.graphon.sh/v1. The same API key works there, and in S3 tools. JSON uses this bare host. S3 adds your workspace ID before the hostname and uses path-style bucket addressing. See S3 API.

Machine-readable contract

Each host has an OpenAPI document at a stable URL: /openapi.json for the API host, and /storage-openapi.json for the storage host. The API host also serves its document at /openapi.json.

Was this page helpful?
View as Markdown