Wiro AI Open Source

Wiro AI open source / Templates and docs

Wiro-Docs

Source of the Wiro AI API docs at wiro.ai/docs. Static HTML with per-page Markdown and llms.txt for models, tasks, LLM streaming, realtime voice and agents.

View on GitHub Docs

Wiro AI

Wiro API Documentation

Source of the Wiro AI API docs at wiro.ai/docs: a static HTML site with per-page Markdown and llms.txt covering model runs, tasks, WebSocket, LLM streaming, realtime voice and the Agent API.

License: MIT llms.txt included No build step

Website Β· Models Β· Docs Β· Dashboard

This repository is the source of wiro.ai/docs, the reference for the Wiro AI API: authentication, running models, tasks, WebSocket and LLM streaming, realtime voice, files, the LLM gateway, the Agent API, organizations, and the MCP and n8n integrations. Every page lives inline in index.html, so the full text can be read without JavaScript, and each page also has a Markdown copy in markdown/, next to a full bundle and an llms.txt summary for LLMs and crawlers. serve.js, a small Node.js server with no dependencies, serves each page at its own /docs/<slug> path with its own meta tags.


Why this repo?

Goal What you get
πŸ“– Human readers Pixel-aligned docs UI: navigation, dark mode, code panel with Shiki highlighting
πŸ€– LLMs All sections live in index.html, readable without JS; llms.txt + Markdown exports
πŸ”Œ Integrators Same content as the product docs: Run, Tasks, WebSocket, LLM streaming, Realtime voice, Files

Features


Documentation map

One row per page, in sidebar order. Each path is live under https://wiro.ai.

Section Path Markdown
Getting Started
Introduction /docs/introduction introduction.md
Authentication /docs/authentication authentication.md
Projects /docs/projects projects.md
Model API Reference
Models /docs/models models.md
Run a Model /docs/run-a-model run-a-model.md
Direct LLM Gateway /docs/completions-api completions-api.md
Model Parameters /docs/model-parameters model-parameters.md
Tasks /docs/tasks tasks.md
LLM & Chat Streaming /docs/llm-chat-streaming llm-chat-streaming.md
WebSocket /docs/websocket websocket.md
Realtime Voice Conversation /docs/realtime-voice-conversation realtime-voice-conversation.md
Realtime Text to Speech /docs/realtime-text-to-speech realtime-text-to-speech.md
Realtime Speech to Text /docs/realtime-speech-to-text realtime-speech-to-text.md
Files /docs/files files.md
Pricing /docs/pricing pricing.md
Concurrency Limits /docs/concurrency-limits concurrency-limits.md
Error Reference /docs/error-reference error-reference.md
FAQ /docs/faq faq.md
Workflow & Studio API Reference
Workflows /docs/workflows workflows.md
Workflow Agent /docs/workflow-agent workflow-agent.md
Studio /docs/studio studio.md
Agent API Reference
Agent Overview /docs/agent-overview agent-overview.md
Agent Builder /docs/agent-builder agent-builder.md
Agent Messaging /docs/agent-messaging agent-messaging.md
Agent WebSocket /docs/agent-websocket agent-websocket.md
Agent Webhooks /docs/agent-webhooks agent-webhooks.md
Agent Credentials & OAuth /docs/agent-credentials agent-credentials.md
Agent Chat Integration /docs/agent-chat-integration agent-chat-integration.md
Agent Skills /docs/agent-skills agent-skills.md
Agent Transactions /docs/agent-transactions agent-transactions.md
Agent Logs /docs/agent-logs agent-logs.md
Agent Use Cases /docs/agent-use-cases agent-use-cases.md
Skills Integration
Meta Ads /docs/integration-metaads-skills integration-metaads-skills.md
TikTok Ads /docs/integration-tiktokads-skills integration-tiktokads-skills.md
Shopify /docs/integration-shopify-skills integration-shopify-skills.md
WooCommerce /docs/integration-woocommerce-skills integration-woocommerce-skills.md
Reddit /docs/integration-reddit-skills integration-reddit-skills.md
Facebook Page /docs/integration-facebook-skills integration-facebook-skills.md
Instagram /docs/integration-instagram-skills integration-instagram-skills.md
LinkedIn /docs/integration-linkedin-skills integration-linkedin-skills.md
Twitter / X /docs/integration-twitter-skills integration-twitter-skills.md
TikTok /docs/integration-tiktok-skills integration-tiktok-skills.md
Google Ads /docs/integration-googleads-skills integration-googleads-skills.md
YouTube /docs/integration-youtube-skills integration-youtube-skills.md
Google Analytics 4 /docs/integration-ga4-skills integration-ga4-skills.md
Roasit /docs/integration-roasit-skills integration-roasit-skills.md
Merchant Center /docs/integration-merchantcenter-skills integration-merchantcenter-skills.md
Google Business Profile /docs/integration-googlebusiness-skills integration-googlebusiness-skills.md
HubSpot /docs/integration-hubspot-skills integration-hubspot-skills.md
Mailchimp /docs/integration-mailchimp-skills integration-mailchimp-skills.md
Google Drive /docs/integration-googledrive-skills integration-googledrive-skills.md
Google Calendar /docs/integration-google-calendar-skills integration-google-calendar-skills.md
Serper Web Search /docs/integration-serper-search-skills integration-serper-search-skills.md
Gmail /docs/integration-gmail-skills integration-gmail-skills.md
Telegram /docs/integration-telegram-skills integration-telegram-skills.md
Firebase /docs/integration-firebase-skills integration-firebase-skills.md
WordPress /docs/integration-wordpress-skills integration-wordpress-skills.md
App Store Connect /docs/integration-appstore-skills integration-appstore-skills.md
Google Play /docs/integration-googleplay-skills integration-googleplay-skills.md
Apollo /docs/integration-apollo-skills integration-apollo-skills.md
Lemlist /docs/integration-lemlist-skills integration-lemlist-skills.md
Brevo /docs/integration-brevo-skills integration-brevo-skills.md
SendGrid /docs/integration-sendgrid-skills integration-sendgrid-skills.md
Twilio Voice /docs/integration-twiliovoice-skills integration-twiliovoice-skills.md
Web Voice /docs/integration-webvoice-skills integration-webvoice-skills.md
Organizations & Teams
Overview /docs/organizations-overview organizations-overview.md
Managing Teams /docs/organizations-managing-teams organizations-managing-teams.md
Team Billing & Spending /docs/organizations-billing organizations-billing.md
Team API Access /docs/organizations-api-access organizations-api-access.md
Integrations
Wiro MCP Server /docs/wiro-mcp-server wiro-mcp-server.md
Self-Hosted MCP /docs/mcp-self-hosted mcp-self-hosted.md
Node.js Library /docs/nodejs-library nodejs-library.md
n8n Wiro Integration /docs/n8n-wiro-integration n8n-wiro-integration.md
Code Examples
Code Examples /docs/code-examples code-examples.md

Full export: full-documentation.md


Run locally

serve.js only uses Node.js built-in modules, so there is nothing to install:

node serve.js

Open http://localhost:8000/docs/ (set PORT to use another port). Each page is served at its own path, for example /docs/files or /docs/tasks, with its own meta tags. Unknown paths return a 404 page, and /docs/index.html returns the full file with every section inline.

Keep data-base-path="/docs" on the <html> tag of index.html: it matches the path serve.js serves under.


Project structure

Wiro-Docs/
β”œβ”€β”€ README.md
β”œβ”€β”€ LICENSE
β”œβ”€β”€ .gitignore
β”œβ”€β”€ index.html                  # Every doc page inline (readable without JS)
β”œβ”€β”€ serve.js                    # Node server: one document per page, per-page meta, search index
β”œβ”€β”€ llms.txt                    # Machine-readable API summary
β”œβ”€β”€ sitemap.xml                 # Sitemap with priorities and change frequencies
β”œβ”€β”€ robots.txt                  # Crawler directives with sitemap reference
β”œβ”€β”€ assets/                     # SVG logos for MCP clients and integrations
β”œβ”€β”€ css/
β”‚   β”œβ”€β”€ docs.css                # Layout, theme (light/dark), typography, components
β”‚   β”œβ”€β”€ wiro-foundation.css     # Design-system tokens and component styles
β”‚   β”œβ”€β”€ mcp-clients.css         # MCP client logos as CSS masks
β”‚   β”œβ”€β”€ lineicons-free.css      # Lineicons icon font
β”‚   └── cursor-custom-llm.png   # Screenshot used on the Direct LLM Gateway page
β”œβ”€β”€ js/
β”‚   β”œβ”€β”€ app.js                  # Navigation, search, TOC, code panel, Shiki
β”‚   └── helpers.js              # Model browser (Tool/List) + shared helpers
β”œβ”€β”€ licenses/
β”‚   └── lineicons-MIT.md        # Lineicons license
└── markdown/                   # One {slug}.md per page + full-documentation.md, kept in sync with index.html (see Contributing)

Contributing

We follow conventional, changelog-friendly commits:

Prefix Use for
[docs] API text, examples, index.html, llms.txt, markdown/*.md
[system] CSS, JS, layout, navigation, tooling

Do not mix [docs] and [system] in one commit.

When you change index.html API content, update the matching markdown/{slug}.md and markdown/full-documentation.md in the same change.


More from Wiro AI

Repository What it is
Wiro-MCP Official MCP server for Wiro AI, @wiro-ai/wiro-mcp on npm
Wiro-LLM Vercel AI SDK provider for chat, images, speech, transcription and video, @wiro-ai/wiro-llm on npm
Wiro-Chromium-Extension Wiro AI extension for Chrome, Edge, Opera and Brave
Wiro-Firefox-Extension Wiro AI add-on for Firefox
Wiro-Safari-Extension Wiro AI extension for Safari on the Mac
Wiro-Plugin Wiro AI plugin for Cursor, Claude Code, Gemini CLI, Devin, Antigravity and Kiro
Wiro-Skills Agent skills for images, image edits, video, music, speech, transcripts, 3D and model search
Swift-QuickStart WiroKit, the Wiro AI SDK for iOS
Kotlin-QuickStart WiroKit, the Wiro AI SDK for Android
Dart-QuickStart Wiro AI SDK for Dart and Flutter, wiro on pub.dev
ReactNative-QuickStart Wiro AI SDK for React Native and Expo, @wiro-ai/wiro-react-native on npm
Swift-Realtime Realtime voice AI example for iOS
Kotlin-Realtime Realtime voice AI example for Android
Dart-Realtime Realtime voice AI example for Flutter
ReactNative-Realtime Realtime voice AI example for React Native
n8n-nodes-wiro One Wiro AI node for n8n with a searchable model picker, @wiro-ai/n8n-nodes-wiro on npm
Wiro-Dify-Plugin Wiro AI plugins for Dify: the LLM gateway as a model provider, plus image, video, speech and music tools
Wiro-ComfyUI Wiro AI nodes for ComfyUI
Wiro-Hermes Wiro AI plugins for Hermes Agent: image, video, audio and 3D tools, plus the LLM gateway as a model provider
Wiro-Zed Wiro AI MCP server extension for Zed
Wiro-Action GitHub Action for Wiro AI models and the LLM gateway, on the GitHub Marketplace
Wiro-Raycast Wiro AI extension for Raycast: image and video generation, LLM chat and model search
Wiro-WordPress Wiro AI plugin for WordPress: featured images, image edits, alt text, narration and SEO suggestions
Wiro-Obsidian Wiro AI plugin for Obsidian: images, video, speech, music, transcription and text tools
Wiro-Blender Wiro AI add-on for Blender: text to 3D, image to 3D and textures
Wiro-Figma Wiro AI plugin for Figma: images, vectors, image edits and text
Wiro-Next-Starter Next.js starter for Wiro AI: Playground, image, video and audio tools, and LLM chat, ready for Vercel and Railway
wiroai.github.io Every open-source project from Wiro AI on one page, with a page for each repository

Website Β· Models Β· Docs Β· X


License

MIT, see LICENSE.