# Spark API documentation

> Spark is smart blob storage that replaces your object store. Store objects
> with the Spark API, then search and query them with AI. These docs serve
> people and agents. Every page has a Markdown twin at the same path plus `.md`.

## Agent rules

- Read the API key from the SPARK_API_KEY environment variable. Never print it.
- Never put a live key in source, a commit, or a log.
- Examples that show `<SPARK_API_KEY>` or `$SPARK_API_KEY` are placeholders.
- Use only the operations in /openapi.json. Do not call bucket, object, search, or query paths.
- Prefer the `.md` form of a page for parsing.

## Get started

- [Overview](/index.md): Spark is smart blob storage that replaces your dumb object store. Store objects with the Spark API, then search and query them with AI.
- [Get started](/get-started.md): Export your API key, list workspace members, and make a first live request.
- [Concepts](/concepts.md): The core Spark ideas: workspace, bucket, object, tenant partition, and the query modes.
- [Guides](/guides.md): Task guides for storing objects, searching, querying, tenant isolation, and wiring up agents.
- [Glossary](/glossary.md): Definitions of the Spark terms used across the docs.

## Guides

- [Store objects](/guides/store-objects.md): Write objects to a smart bucket with the Spark API. Spark indexes each object for search and query.
- [Keyword search](/guides/keyword-search.md): Run a fast keyword search over the objects in a bucket.
- [Vector / RAG search](/guides/vector-search.md): Retrieve the most relevant chunks for a natural-language query.
- [Agentic query & citations](/guides/agentic-query.md): Ask a question and get an answer with citations to the source objects.
- [Tenant isolation](/guides/tenant-isolation.md): Partition data by your own customer or tenant on writes, search, and query.
- [Authentication & keys](/guides/authentication.md): Create API keys, assign viewer, editor, or admin roles, and send them with every request.
- [Agents & MCP](/guides/agents-mcp.md): Give an agent the same control as the API through the Spark MCP server.
- [Claude Code plugin](/guides/claude-code-plugin.md): Install the Spark plugin to wire the MCP server and skills into Claude Code.

## API reference

- [API reference](/api.md): The Spark HTTP API: base URL, workspace paths, and how to make a first request.
- [Authentication](/api/authentication.md): How the Spark API authenticates requests and how to send your key.
- [Errors](/api/errors.md): The Spark error shape, HTTP classes, error codes, and how to handle them.
- [Limits](/api/limits.md): JSON body and invitation-batch limits for the Spark beta. The beta sets no rate limits.
- [Versioning & deprecations](/api/versioning.md): How Spark versions the API and announces deprecations with dates.
- [Get a workspace](/api/workspaces/get-workspace.md): Confirms that the caller can access the workspace.
- [List members](/api/members/list-members.md): Lists active members in the workspace.
- [Update a member role](/api/members/update-member.md): Changes a member's role.
- [Remove a member](/api/members/remove-member.md): Removes a member from the workspace.
- [List a member's API keys](/api/members/list-member-api-keys.md): Lists personal API keys for another member.
- [List invitations](/api/invitations/list-invitations.md): Lists pending invitations for the workspace.
- [Invite members](/api/invitations/create-invitations.md): Invites one or more email addresses with the same role.
- [Resend an invitation](/api/invitations/resend-invitation.md): Sends the invitation email again.
- [Update an invitation role](/api/invitations/update-invitation.md): Changes the role on a pending invitation.
- [Revoke an invitation](/api/invitations/revoke-invitation.md): Revokes a pending invitation.
- [List service accounts](/api/service-accounts/list-service-accounts.md): Lists active service accounts in the workspace.
- [Create a service account](/api/service-accounts/create-service-account.md): Creates a service account.
- [Get a service account](/api/service-accounts/get-service-account.md): Returns one service account.
- [Update a service account](/api/service-accounts/update-service-account.md): Updates the name, description, or role of a service account.
- [Delete a service account](/api/service-accounts/delete-service-account.md): Deletes a service account and revokes its keys.
- [List API keys](/api/api-keys/list-api-keys.md): Lists API keys.
- [Create an API key](/api/api-keys/create-api-key.md): Creates a personal API key for the caller, or a service-account key when owner.kind is service_account.
- [Revoke an API key](/api/api-keys/revoke-api-key.md): Revokes an API key.

## Changelog

- [Changelog](/changelog.md): Notable Spark API changes and deprecations, newest first.