# Jam

- [jam-nodes](https://docs.spreadjam.com/index.md): An extensible, type-safe workflow node framework for building automation pipelines in TypeScript.
- [Quick Start](https://docs.spreadjam.com/quickstart.md): Get up and running with jam-nodes in minutes.
- [Types](https://docs.spreadjam.com/core/types.md): Core type definitions for jam-nodes.
- [NodeRegistry](https://docs.spreadjam.com/core/registry.md): Manage node definitions -- register, query, validate, and execute nodes.
- [ExecutionContext](https://docs.spreadjam.com/core/execution-context.md): Manage workflow variables, interpolation, JSONPath, and node output storage.
- [Utilities](https://docs.spreadjam.com/core/utilities.md): Helper functions for defining nodes and preparing inputs.
- [Built-in Nodes Overview](https://docs.spreadjam.com/nodes/overview.md): All 16 built-in nodes grouped by category.
- [Logic Nodes](https://docs.spreadjam.com/nodes/logic.md): Flow control nodes: conditional branching, delays, and end markers.
- [Transform Nodes](https://docs.spreadjam.com/nodes/transform.md): Data manipulation nodes: map and filter arrays.
- [Integration Nodes](https://docs.spreadjam.com/nodes/integration.md): External API integrations: HTTP requests, social monitoring, contacts, and email drafting.
- [AI Nodes](https://docs.spreadjam.com/nodes/ai.md): AI-powered nodes: social analysis, video generation, SEO research, and keyword generation.
- [Playground](https://docs.spreadjam.com/playground/overview.md): Test and experiment with jam-nodes without building a full application.
- [CLI Reference](https://docs.spreadjam.com/playground/cli.md): Full command reference for the jam-nodes CLI playground.
- [Web Playground](https://docs.spreadjam.com/playground/web.md): Browser-based UI for visual exploration and testing of jam-nodes.
- [Creating Custom Nodes](https://docs.spreadjam.com/creating-nodes.md): Build your own jam-nodes with Zod schemas, executors, and registry integration.
- [MCP Integration](https://docs.spreadjam.com/mcp.md): Connect AI agents to jam-nodes documentation via Model Context Protocol servers.
- [Platform API](https://docs.spreadjam.com/api-reference/overview.md): Authenticate with a workspace API key and call the Jam REST API over HTTPS.
- [The authenticated key's workspace](https://docs.spreadjam.com/api-reference/meta/the-authenticated-keys-workspace.md): Returns the workspace and environment the bearer key is scoped to.
- [AI-visibility overview](https://docs.spreadjam.com/api-reference/analytics/ai-visibility-overview.md): Headline metrics, per-platform breakdown, citation leaderboard, and topic rankings.
- [Per-prompt analytics](https://docs.spreadjam.com/api-reference/analytics/per-prompt-analytics.md): Tracked prompts with per-platform state and KPI/trend metrics, one page at a time.
- [Flattened metric rows](https://docs.spreadjam.com/api-reference/analytics/flattened-metric-rows.md): Chart-ready rows for one of visibility, competitors, citations, platforms, or topics.
- [Keyword and topic visibility](https://docs.spreadjam.com/api-reference/keywords/keyword-and-topic-visibility.md): Per-topic visibility rankings (the `topics` analytics metric under its own name).
- [The active brand profile](https://docs.spreadjam.com/api-reference/brand/the-active-brand-profile.md): Positioning, audience, product, tone, competitors, excluded topics, and pin state.
- [Save brand positioning](https://docs.spreadjam.com/api-reference/brand/save-brand-positioning.md): Author a new positioning version. Requires a paid plan.
- [Pin the competitor list](https://docs.spreadjam.com/api-reference/brand/pin-the-competitor-list.md): Pin and lock the competitor list on the active profile. Requires a paid plan.
- [Clear the competitor pin](https://docs.spreadjam.com/api-reference/brand/clear-the-competitor-pin.md): Clear the competitor pin on the active profile, leaving the list untouched. Requires a paid plan.
- [Start a recalibration](https://docs.spreadjam.com/api-reference/brand/start-a-recalibration.md): Rebuild the GEO system layer toward the active authored positioning.
- [Tracked and archived prompts](https://docs.spreadjam.com/api-reference/prompts/tracked-and-archived-prompts.md): The editable prompts for the workspace's active GEO project.
- [Reword many prompts at once](https://docs.spreadjam.com/api-reference/prompts/reword-many-prompts-at-once.md): Reword up to 100 tracked prompts by id in one atomic operation, keeping each prompt's measurement history. Any item that is missing, not editable, or has invalid text fails the whole batch. Requires a paid plan.
- [Track a new prompt](https://docs.spreadjam.com/api-reference/prompts/track-a-new-prompt.md): Add a tracked prompt to the workspace's active GEO project. Requires a paid plan.
- [Prompt cap state](https://docs.spreadjam.com/api-reference/prompts/prompt-cap-state.md): How many prompt slots are occupied and the effective cap.
- [Stop tracking a prompt](https://docs.spreadjam.com/api-reference/prompts/stop-tracking-a-prompt.md): Soft-archive a tracked prompt (measurement history is retained). Requires a paid plan.
- [Reword a prompt in place](https://docs.spreadjam.com/api-reference/prompts/reword-a-prompt-in-place.md): Reword a tracked prompt, keeping its measurement history. Requires a paid plan.
- [Track many prompts at once](https://docs.spreadjam.com/api-reference/prompts/track-many-prompts-at-once.md): Track up to 100 prompts in one atomic operation. An incoming text matching an existing tracked prompt reuses that prompt rather than duplicating it. The prompt cap is checked once over the whole batch; a batch that would exceed it is rejected and nothing is tracked. Requires a paid plan.
- [Pause or resume a prompt](https://docs.spreadjam.com/api-reference/prompts/pause-or-resume-a-prompt.md): Toggle whether a tracked prompt is measured. Requires a paid plan.
- [Replace a prompt, resetting history](https://docs.spreadjam.com/api-reference/prompts/replace-a-prompt-resetting-history.md): Reword a tracked prompt and reset its measurement history (archives the old prompt, tracks a new one in its place). Requires a paid plan.
- [List API keys](https://docs.spreadjam.com/api-reference/api-keys/list-api-keys.md): The workspace's API keys (never the raw secret).
- [Create an API key](https://docs.spreadjam.com/api-reference/api-keys/create-an-api-key.md): Create a key for the workspace. The raw secret is returned once, here, and never again.
- [Revoke an API key](https://docs.spreadjam.com/api-reference/api-keys/revoke-an-api-key.md): Revoke a key in the workspace. Revoking is a soft delete and is idempotent.

## OpenAPI Specs

- [openapi](https://api.spreadjam.com/openapi.json)

## Optional

- [Website](https://www.spreadjam.com)
- [Blog](https://www.spreadjam.com/blogs)
- [Open Source](https://github.com/wespreadjam/jam-nodes)
- [Discord](https://dsc.gg/spreadjam)
- [npm](https://www.npmjs.com/org/jam-nodes)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.