API Documentation

Everything you need to integrate with PlanetGraph.

Quick Start

Start with these prompts in your preferred coding agent, then iterate with follow-up questions.

Take a look at https://planetgraph.ai/llms.txt and tell me what it can do

Read the documentation on https://planetgraph.ai/llms.txt and write me a Python script to query it for people who worked at both Apple and Google

Interactive

Explore the live OpenAPI reference, authorize with an API key, and try requests directly against the API.

Open interactive API docs open_in_new

Authentication

Use X-API-Key for API keys. Authorization: Bearer ... is only for Firebase user tokens.

curl -H "X-API-Key: YOUR_API_KEY" \
   https://api.planetgraph.ai/api/v1/nodes

Account & API Keys

Inspect your account identity and manage API keys for integrations.

GET/api/v1/api-keys

List Api Keys

POST/api/v1/api-keys

Create Api Key

DELETE/api/v1/api-keys/{key_id}

Revoke Api Key

POST/api/v1/auth/mfa/recovery-code

Use Recovery Code

GET/api/v1/me

Get Me

GET/api/v1/me/security

Get Security Status

GET/api/v1/me/security/recovery-codes

Get Recovery Code Status

POST/api/v1/me/security/recovery-codes

Regenerate Recovery Codes

Nodes

Create, read, update, and delete graph nodes.

GET/api/v1/nodes

List Nodes

POST/api/v1/nodes

Create Node

GET/api/v1/nodes/{node_id}

Get Node

PATCH/api/v1/nodes/{node_id}

Update Node

DELETE/api/v1/nodes/{node_id}

Delete Node

GET/api/v1/nodes/types

List Node Types

Edges

Create and manage relationships between nodes.

GET/api/v1/edges

List Edges

POST/api/v1/edges

Create Edge

GET/api/v1/edges/{edge_id}

Get Edge

PATCH/api/v1/edges/{edge_id}

Update Edge

DELETE/api/v1/edges/{edge_id}

Delete Edge

GET/api/v1/edges/by-node/{node_id}

List Edges For Node

GET/api/v1/edges/types

List Edge Types

Properties

Manage properties on nodes and edges with granular access controls.

POST/api/v1/admin/rotate-keys/{account_id}

Rotate Keys

GET/api/v1/edges/{edge_id}/properties

List Edge Properties

POST/api/v1/edges/{edge_id}/properties

Create or Replace Edge Property

GET/api/v1/nodes/{node_id}/properties

List Node Properties

POST/api/v1/nodes/{node_id}/properties

Create or Replace Node Property

PUT/api/v1/properties/{property_id}

Update Property

DELETE/api/v1/properties/{property_id}

Delete Property

Search

Find searchable properties and semantic matches while preserving visibility and returnability rules.

GET/api/v1/search/properties

Search Properties

GET/api/v1/search/semantic

Semantic Search

POST/api/v1/search/vector

Vector Search

Queries

Execute Cypher queries and access query history.

GET/api/v1/queries/history

Query History

POST/api/v1/query

Run Query

Billing

Manage your token balance and view transaction history.

GET/api/v1/account/balance

Account Balance

POST/api/v1/account/purchase

Purchase Tokens

GET/api/v1/account/transactions

Account Transactions

POST/api/v1/admin/pricing

Create Pricing

GET/api/v1/pricing

Get Pricing

Access Control

Define and manage access policies for your data.

GET/api/v1/access-policies

List Access Policies

POST/api/v1/access-policies

Create Access Policy

PUT/api/v1/access-policies/{policy_id}

Update Access Policy

DELETE/api/v1/access-policies/{policy_id}

Delete Access Policy

PATCH/api/v1/feedback/{feedback_id}

Update Feedback

DELETE/api/v1/feedback/{feedback_id}

Delete Feedback

PATCH/api/v1/properties/{property_id}/access-policy

Assign Access Policy

GET/api/v1/properties/{property_id}/feedback

List Feedback

POST/api/v1/properties/{property_id}/feedback

Create Feedback

POST/api/v1/properties/{property_id}/purchase

Purchase Property Access

GET/api/v1/searchability/property-search-rules

List Property Search Rules

PUT/api/v1/searchability/property-search-rules

Upsert Property Search Rule

DELETE/api/v1/searchability/property-search-rules/{rule_id}

Delete Property Search Rule

Audit Logs

Review account-scoped activity for traceability and compliance workflows.

GET/api/v1/audit-logs

List Audit Logs

Interactive API Reference →