# Nodaro

> AI workflow editor: compose text-to-image, AI video generation (text-to-video / image-to-video unified in the Generate Video node), audio synthesis, video composition, and LLM nodes into multi-step DAGs that run autonomously on a server.

Nodaro is a Fastify backend + Vite/React frontend, source-available under the [Nodaro Sustainable Use License](https://github.com/nodaroai/app.nodaro.ai/blob/main/LICENSE). The backend is REST-first; the included visual editor is one of many possible clients. A typed SDK (`@nodaro/sdk`) and OAuth 2.0 third-party-app system mean any developer can build alternative frontends, automations, or integrations on top of a hosted Nodaro instance.

## Quickstart

- [Community Edition Quickstart](https://nodaroai.github.io/app.nodaro.ai/community-edition-quickstart.md): self-host Nodaro in 5 steps using Docker Compose
- [Architecture](https://nodaroai.github.io/app.nodaro.ai/architecture.md): system overview — frontend, backend, workers, auth modes, edition tiers
- [Deployment](https://nodaroai.github.io/app.nodaro.ai/deployment.md): full self-hosting guide with reverse proxy, scaling, backups

## SDK & CLI

- [SDK Quickstart](https://nodaroai.github.io/app.nodaro.ai/sdk-quickstart.md): install `@nodaro/sdk`, three auth modes, error handling, common recipes
- [SDK Reference](https://nodaroai.github.io/app.nodaro.ai/sdk-reference.md): every public export — `createClient`, auth providers, error classes, 19 resource classes (workflows, projects, jobs, executions, nodes, characters, locations, objects, pipelines, reduce, promptHelper, apps, developerApps, oauth, voices, credits, uploads, presets, community)
- [Video models](https://nodaroai.github.io/app.nodaro.ai/nodes/ai-video/generate-video.md): every generate-video provider id with modes, durations, resolutions, credit costs, and the platform default (`seedance-2-fast`, 4s when unspecified)
- [Image models](https://nodaroai.github.io/app.nodaro.ai/nodes/ai-image/generate-image.md): every generate-image provider id with params and credit costs
- [OpenAPI 3.1 spec](https://app.nodaro.ai/v1/openapi.json): live machine-readable spec of the automation core (workflows, jobs, node run + discovery, oauth, credit costs) — generate typed clients for any language
- [@nodaro/sdk on npm](https://www.npmjs.com/package/@nodaro/sdk): package README includes a credentials guide (API token / OAuth app / self-hosted Supabase) and a paste-into-your-agent primer for building apps with the SDK
- [CLI](https://nodaroai.github.io/app.nodaro.ai/cli.md): terminal client `@nodaro/cli` — multi-profile auth, `--watch` polling, JSON output, single-binary distribution via `bun build --compile` for darwin/linux/windows

## API & integrations

- [API Integration](https://nodaroai.github.io/app.nodaro.ai/api-integration.md): server-to-server via API tokens (`ndr_<64hex>`), 5 public endpoints, sync vs async, webhooks, rate limits
- [Character Platform](https://nodaroai.github.io/app.nodaro.ai/character-platform.md): full programmatic Character Studio — create / update / soft-delete / restore characters, portrait + asset + motion generation, LLM-captioned portrait approval. Covered across REST + SDK + CLI + MCP.
- [Community Library](https://nodaroai.github.io/app.nodaro.ai/community-library.md): admin-curated catalog of shared characters/locations/objects (Business + Cloud editions). Admins publish; any user browses + clones into their own library as independent copies. Likeness/consent attestation on publish; report + admin takedown. REST + SDK (`client.community`); publishing is admin/editor-only.
- [OAuth Flow](https://nodaroai.github.io/app.nodaro.ai/oauth-flow.md): RFC 6749 authorization-code flow for third-party apps acting on behalf of users — app registration, scope vocabulary (11 scopes), code exchange, token revocation (RFC 7009)
- [Node Reference](https://nodaroai.github.io/app.nodaro.ai/nodes/README.md): every supported node type with parameters, providers, and examples
- [Choosing Models](https://nodaroai.github.io/app.nodaro.ai/choosing-models.md): which model to use for a task — everyday vs premium tiers + a use-case → model table across image, video, audio, and text; generated from the model catalog (same data as the MCP `list_models` tool)
- [Prompt Snippets](https://nodaroai.github.io/app.nodaro.ai/prompt-snippets.md): reusable inline prompt fragments inserted via a `/` slash menu or a snippets button — 67-entry image+video factory catalog plus user-created snippets, scoped by node modality + prompt/negative target. Plain-text storage (what you see is what runs); REST exposes read-only `GET /v1/prompt-snippets` + `/factory`.

## Contributing

- [Contributing](https://nodaroai.github.io/app.nodaro.ai/contributing.md): dev environment setup, coding standards, branching, testing, releasing

## Optional

- [Repository](https://github.com/nodaroai/app.nodaro.ai): source code, issues, PRs
- [Hosted version](https://nodaro.ai): managed instance with credits + billing