Getting started

Welcome. The Glitter AI API lets your own scripts and integrations read what your team has built in Glitter: the guides you have published, the teams a key can see, and who is on them. Pull guides into your wiki, sync them to a help desk, feed them to an internal tool, or build a report, all with one API key and a few plain HTTPS calls.

If what you want is an AI assistant that can read your guides, you do not need the API at all. Claude, ChatGPT, Microsoft Copilot, and other assistants connect over MCP in a couple of clicks from Account → MCP in the app, and sign in as you rather than with a key.

Create a key

• A team admin creates a key under My Team → API. It reaches that team.
• An organization admin creates a key under Organization Settings → API. It reaches every team in the organization, including teams that join later.

Pick the scopes the key needs and an expiry. The full key is shown once, at creation. A key sees every guide of its teams, drafts included, as a team admin does; only a guide whose recording is still processing stays out.

Make a call

Every request carries the key as a bearer token:

curl 'https://www.glitter.io/api/v1/guides?limit=5' \
  -H 'Authorization: Bearer glt_live_…'

Lists page with limit and cursor; pass the next_cursor of one page as the cursor of the next until it is null. Every refusal is one JSON shape with a stable code to switch on.

Hear about changes

You do not have to poll. Add a webhook endpoint under My Team → API or Organization Settings → API, pick the events, and Glitter will POST a signed JSON envelope to your endpoint URL when a guide is created, updated or deleted, finishes processing, or when someone joins or leaves a team. The Webhooks guide covers setup, every event and its payload, the signature check in seven languages, retries and troubleshooting.

Plans and previews

Full guides through the API and MCP come with Growth and every plan above it. On any other plan a guide comes back as a preview: the same first part a file export gets, with a notice field and a closing note in markdown_body that say so. A guide past the plan’s guide limit carries locked: true and comes back as the short cut its public page shows. Listing is never cut: every guide a key may see is listed, with its locked flag.

Next

• The API reference lists every endpoint with its parameters, responses and errors, and every webhook event with its payload.
• The same document is served as OpenAPI JSON for generators and tooling.