Get started

Prerequisites

You need a Spark workspace and an API key. Create a key in the control plane, then export it as SPARK_API_KEY. The value is the full bearer token Spark showed once, in the form gsk_ plus the access-key id and secret. Spark reads the key from your environment. Never paste a key into source.

Also export SPARK_WORKSPACE_ID for the workspace that owns the key.

1. List members

Confirm the key works by listing the people in your workspace. A viewer key can call this route.

curl \
  --url "https://api.spark.graphon.ai/v1/workspaces/$SPARK_WORKSPACE_ID/members" \
  --header "Authorization: Bearer $SPARK_API_KEY"

2. Create another key

Create a personal API key for local use. Spark returns the secret and bearer token once. Store them in a secret manager.

curl --request POST \
  --url "https://api.spark.graphon.ai/v1/workspaces/$SPARK_WORKSPACE_ID/api-keys" \
  --header "Authorization: Bearer $SPARK_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name": "Local CLI", "role": "viewer"}'

Next steps

1. Read the authentication guide for roles and key rotation.
2. Browse the API reference for every live operation.