# Inworld AI Documentation

## Home

### Get Started
- [Hello Inworld](https://docs.inworld.ai/docs/introduction): Inworld develops AI products for builders of consumer applications. This suite of documentation covers everything you need to use Inworld's products to create AI powered experiences.
- [Quickstart: Runtime](https://docs.inworld.ai/docs/node/quickstart): Get started with Inworld's Runtime
- [Quickstart: Text to Speech (TTS)](https://docs.inworld.ai/docs/quickstart-tts): Learn how to make your first Inworld TTS API request

### Runtime
- [Overview](https://docs.inworld.ai/docs/runtime/overview): Inworld Runtime is an AI backend engineered for consumer applications.
- [Installation](https://docs.inworld.ai/docs/runtime/get-started): Get started by downloading one of our Runtime SDKs
- [Vibe Code](https://docs.inworld.ai/docs/guides/vibe-code): Learn how to vibe code with Inworld Runtime
- [Graphs](https://docs.inworld.ai/docs/node/core-concepts/graphs): Build adaptive graphs with pre-optimized nodes for AI workflows
- [Metrics](https://docs.inworld.ai/docs/node/core-concepts/metrics): Define and send custom metrics to track your application performance
- [Experiments](https://docs.inworld.ai/docs/portal/graph-registry): Test models, prompts, and graphs instantly without redeployment

### Text to Speech
- [Overview](https://docs.inworld.ai/docs/tts/tts): Convert text into realistic, expressive speech
- [TTS Models](https://docs.inworld.ai/docs/tts/tts-models): Overview of available TTS models and their capabilities
- [Voice Cloning](https://docs.inworld.ai/docs/tts/voice-cloning): Create a personalized voice clone in seconds
- [TTS Playground](https://docs.inworld.ai/docs/tts/tts-playground): Explore TTS models and test voices
- [Integrations](https://docs.inworld.ai/docs/tts/integrations): Integrate Inworld's TTS with leading voice platforms

### Resources
- [Release Notes](https://docs.inworld.ai/docs/release-notes): Product updates and improvements

## Runtime SDKs

### Node.js v0.6

#### Get Started
- [Overview](https://docs.inworld.ai/docs/node/overview): Introduction to the Node.js Runtime SDK
- [Installation](https://docs.inworld.ai/docs/node/installation): Install the Node.js Runtime SDK
- [Quickstart](https://docs.inworld.ai/docs/node/quickstart): Build a command line chat experience using the Inworld Node.js Runtime SDK
- [Troubleshooting](https://docs.inworld.ai/docs/node/troubleshooting): Common issues and solutions for the Node.js SDK

#### Core Concepts
- [Overview](https://docs.inworld.ai/docs/node/core-concepts/overview): Understanding Runtime graphs, nodes, and execution
- [Graphs](https://docs.inworld.ai/docs/node/core-concepts/graphs): Creating and connecting nodes with edges to build AI pipelines
- [Nodes](https://docs.inworld.ai/docs/node/core-concepts/nodes): Built-in and custom nodes for AI processing tasks
- [Edges](https://docs.inworld.ai/docs/node/core-concepts/edges): Connections between nodes that control data flow
- [Metrics](https://docs.inworld.ai/docs/node/core-concepts/metrics): Define and send custom metrics to track your application performance

#### Templates & Guides
- [Overview](https://docs.inworld.ai/docs/node/templates/overview): Explore our available templates to jumpstart your project
- [Use an LLM](https://docs.inworld.ai/docs/node/templates/llm): Build AI applications using large language models
- [Convert Text to Speech (TTS)](https://docs.inworld.ai/docs/node/templates/tts): Add speech synthesis to your applications
- [Convert Speech to Text (STT)](https://docs.inworld.ai/docs/node/templates/stt): Add speech recognition to your applications
- [Build a Custom Node with Multiple Inputs](https://docs.inworld.ai/docs/node/templates/multi-input): Create custom processing nodes with multiple input sources
- [Using Context](https://docs.inworld.ai/docs/node/templates/process-context): Learn how to use context in your graph processing
- [Voice Agent](https://docs.inworld.ai/docs/node/templates/voice-agent): Build a complete voice-enabled AI agent
- [Language Learning App](https://docs.inworld.ai/docs/node/templates/language-app): Create language learning experiences with AI
- [Multimodal Companion](https://docs.inworld.ai/docs/node/templates/multimodal-companion): Build AI companions with multiple modalities
- [Generate Images with MiniMax](https://docs.inworld.ai/docs/node/templates/comic-generator): Create image generation workflows

#### Runtime Reference
- [Overview](https://docs.inworld.ai/docs/node/runtime-reference/overview): Inworld's Node.js Runtime SDK is a comprehensive toolkit for building AI-powered applications.

##### Graph
- [Graph](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_graph.Graph): Represents a graph that can be executed.
- [ExecutionResult](https://docs.inworld.ai/docs/node/runtime-reference/interfaces/graph_graph.ExecutionResult): Interface defining the result of graph execution
- [ExecutionContext](https://docs.inworld.ai/docs/node/runtime-reference/interfaces/graph_graph.ExecutionContext): Interface defining the execution context for graphs
- [GraphBuilder](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_graph_builder.GraphBuilder): Builder for creating graph configurations
- [GraphBuilderProps](https://docs.inworld.ai/docs/node/runtime-reference/types/graph_dsl_graph_builder.GraphBuilderProps): Configuration properties for graph builder
- [SubgraphBuilder](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_graph_config_dsl.SubgraphBuilder): Builder for creating reusable subgraphs
- [SequentialGraphBuilder](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_sequential_graph_builder.SequentialGraphBuilder): Builder for sequential graph execution
- [GraphExecutionManager](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_GraphExecutionManager.GraphExecutionManager): Registry for managing graph executions

##### Nodes
- [AbstractNode](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_nodes_builtin_abstract_node.AbstractNode): Base class for all nodes in the graph system
- [AbstractNodeProps](https://docs.inworld.ai/docs/node/runtime-reference/interfaces/graph_dsl_nodes_abstract_node.AbstractNodeProps): Properties interface for abstract nodes
- [CustomNode](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_nodes_builtin_custom_node.CustomNode): Base class for creating custom processing nodes
- [CustomNodeProps](https://docs.inworld.ai/docs/node/runtime-reference/interfaces/graph_dsl_nodes_custom_node.CustomNodeProps): Properties interface for custom nodes
- [ProcessContext](https://docs.inworld.ai/docs/node/runtime-reference/interfaces/graph_nodes_custom_process_context_Impl.ProcessContext): Context interface for custom node processing
- [RemoteLLMChatNode](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_nodes_builtin_remote_llm_chat_node.RemoteLLMChatNode): Node for remote LLM chat interactions
- [RemoteLLMChatNodeProps](https://docs.inworld.ai/docs/node/runtime-reference/interfaces/graph_dsl_nodes_remote_llm_chat_node.RemoteLLMChatNodeProps): Properties for remote LLM chat nodes
- [RemoteTTSNode](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_nodes_builtin_remote_tts_node.RemoteTTSNode): Node for remote text-to-speech conversion
- [RemoteTTSNodeProps](https://docs.inworld.ai/docs/node/runtime-reference/interfaces/graph_dsl_nodes_remote_tts_node.RemoteTTSNodeProps): Properties for remote TTS nodes
- [TextAggregatorNode](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_nodes_builtin_text_aggregator_node.TextAggregatorNode): Node for aggregating text data
- [TextChunkingNode](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_nodes_builtin_text_chunking_node.TextChunkingNode): Node for chunking text into smaller pieces
- [SafetyCheckerNode](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_nodes_builtin_safety_checker_node.SafetyCheckerNode): Node for content safety checking
- [TextClassifierNode](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_nodes_builtin_text_classifier_node.TextClassifierNode): Node for text classification tasks
- [ClassifierClass](https://docs.inworld.ai/docs/node/runtime-reference/interfaces/graph_dsl_nodes_text_classifier_node.ClassifierClass): Interface for classifier class definitions
- [ClassifierConfig](https://docs.inworld.ai/docs/node/runtime-reference/interfaces/graph_dsl_nodes_text_classifier_node.ClassifierConfig): Configuration interface for text classifiers

##### GraphTypes
- [GraphTypes](https://docs.inworld.ai/docs/node/runtime-reference/modules/common_data_types_GraphTypes): Graph data types used for input and output between nodes
- [AbstractApiDataType](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_abstract_api_data_type.AbstractApiDataType): Base class for all API data types
- [Audio](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_audio.Audio): Audio data type for graph processing
- [ClassificationResult](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_classification_result.ClassificationResult): Data type for classification results
- [Content](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_content.Content): Content data type for text and media
- [GoalAdvancement](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_goal_advancement.GoalAdvancement): Data type for goal progression tracking
- [KnowledgeRecords](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_knowledge_records.KnowledgeRecords): Data type for knowledge base records
- [ListToolsResponse](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_list_tools_response.ListToolsResponse): Response type for tool listings
- [LLMChatRequest](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_llm_chat_request.LLMChatRequest): Request type for LLM chat interactions
- [MatchedIntents](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_matched_intents.MatchedIntents): Data type for intent matching results
- [MatchedKeywords](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_matched_keywords.MatchedKeywords): Data type for keyword matching results
- [MemoryState](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_memory_state.MemoryState): Data type for memory state management
- [SafetyResult](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_safety_result.SafetyResult): Data type for safety check results
- [ToolCallRequest](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_tool_call_request.ToolCallRequest): Request type for tool function calls
- [ToolCallResponse](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_tool_call_response.ToolCallResponse): Response type for tool function calls
- [TTSRequest](https://docs.inworld.ai/docs/node/runtime-reference/classes/common_data_types_api_tts_request.TTSRequest): Request type for text-to-speech conversion

##### Components
- [RemoteLLMComponent](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_components_remote_llm_component.RemoteLLMComponent): LLM provider configuration component
- [RemoteKnowledgeComponent](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_components_remote_knowledge_component.RemoteKnowledgeComponent): Knowledge base configuration component
- [RemoteEmbedderComponent](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_components_remote_embedder_component.RemoteEmbedderComponent): Text embedding configuration component
- [RemoteSTTComponent](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_components_remote_stt_component.RemoteSTTComponent): Speech-to-text configuration component
- [RemoteTTSComponent](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_components_remote_tts_component.RemoteTTSComponent): Text-to-speech configuration component
- [MCPClientComponent](https://docs.inworld.ai/docs/node/runtime-reference/classes/graph_dsl_components_mcp_client_component.MCPClientComponent): MCP server configuration component

##### Graph Configs
- [TextGenerationConfig](https://docs.inworld.ai/docs/node/runtime-reference/interfaces/graph_dsl_graph_config_schema.TextGenerationConfig): Configuration interface for text generation

##### Telemetry
- [Telemetry](https://docs.inworld.ai/docs/node/runtime-reference/modules/telemetry): Capture metrics, trace, and logs to help with understanding and optimizing your AI pipeline

### CLI
- [Overview](https://docs.inworld.ai/docs/node/cli/overview): Toolkit for graph development, deployment, and experimentation  
- [Quickstart](https://docs.inworld.ai/docs/node/developer-tools/quickstart): Install and configure the Inworld CLI for local development and testing
- [Cloud Deployment](https://docs.inworld.ai/docs/node/cli/deploy): Deploy graphs to persistent endpoints for production use
- [Graph Variants & Experimentation](https://docs.inworld.ai/docs/node/cli/variants): Create and manage graph variants for A/B testing and experimentation
- [Advanced Integration & Workflows](https://docs.inworld.ai/docs/node/cli/advanced): Complete CLI workflows, Portal integration, and production best practices
- [Troubleshooting](https://docs.inworld.ai/docs/node/cli/troubleshooting): Common issues and solutions for the CLI

## Models
- [Models Overview](https://docs.inworld.ai/docs/models): Overview of all available models including TTS, LLM, STT, and Embeddings

## Unreal Engine Runtime

### Get Started
- [Overview](https://docs.inworld.ai/docs/unreal-engine/runtime/overview): Get started with the Unreal Runtime
- [Installation](https://docs.inworld.ai/docs/runtime/get-started): Get started by downloading one of our Runtime SDKs
- [Authentication](https://docs.inworld.ai/docs/unreal-engine/runtime/authentication): Authentication setup for Unreal Engine Runtime
- [Core Concepts](https://docs.inworld.ai/docs/unreal-engine/runtime/core-concepts): Understanding graphs, nodes, and AI components in Unreal
- [Using LLMs](https://docs.inworld.ai/docs/unreal-engine/runtime/llm): Large Language Models integration in Unreal Engine
- [Graph Editor](https://docs.inworld.ai/docs/unreal-engine/runtime/graph-editor): Visual graph editor for building AI pipelines in Unreal

### Runtime Reference
- [Overview](https://docs.inworld.ai/docs/unreal-engine/runtime/runtime-reference/overview): The Inworld Runtime for Unreal Engine components
- [Inworld Edge Asset](https://docs.inworld.ai/docs/unreal-engine/runtime/runtime-reference/InworldEdgeAsset): Edge asset management in Unreal Engine

## TTS Capabilities & Best Practices

### Capabilities
- [Voice Tags](https://docs.inworld.ai/docs/tts/capabilities/voice-tags): Add emotional context and speaking style to your speech
- [Audio Markups](https://docs.inworld.ai/docs/tts/capabilities/audio-markups): Control speech synthesis with markup tags
- [Custom Pronunciation](https://docs.inworld.ai/docs/tts/capabilities/custom-pronunciation): Define custom pronunciations for specific words
- [Timestamps](https://docs.inworld.ai/docs/tts/capabilities/timestamps): Get precise timing information for generated speech
- [Generating Audio](https://docs.inworld.ai/docs/tts/capabilities/generating-audio): Core audio generation capabilities

### Best Practices
- [Generating Speech](https://docs.inworld.ai/docs/tts/best-practices/generating-speech): Learn best practices for synthesizing high-quality speech
- [Voice Cloning](https://docs.inworld.ai/docs/tts/best-practices/voice-cloning): Learn best practices for producing high-quality voice clones

### Tools
- [TTS Playground](https://docs.inworld.ai/docs/tts/tts-playground): Explore TTS models and test voices

### Resources
- [Billing](https://docs.inworld.ai/docs/tts/resources/billing): Billing information for TTS usage
- [Support](https://docs.inworld.ai/docs/tts/resources/support): Get support for TTS

## Guides
- [Run an Experiment](https://docs.inworld.ai/docs/guides/ab-experiments): Learn how to run an A/B experiment to optimize your metrics

## Resources
- [Billing](https://docs.inworld.ai/docs/resources/billing): Billing information and pricing details
- [Release Notes: Runtime](https://docs.inworld.ai/docs/release-notes/runtime-node): Product updates and improvements to Node.js Runtime
- [Release Notes: TTS](https://docs.inworld.ai/docs/release-notes/tts): Product updates and improvements to TTS

## API Reference

### Introduction
- [API Authentication](https://docs.inworld.ai/api-reference/introduction): Learn about authentication methods including Basic and JWT authentication

## LLM APIs

### LLM Service
- [Generate chat completion response](https://docs.inworld.ai/api-reference/llmAPI/llmservice/generate-chat-completion-response): Generates a response for the given chat conversation
- [Generate text completion response](https://docs.inworld.ai/api-reference/llmAPI/llmservice/generate-text-completion-response): Generates a text completion for the given prompt

## Knowledge APIs

### Knowledge Service
- [Create knowledge](https://docs.inworld.ai/api-reference/knowledgeAPI/knowledgeservice/create-knowledge): Create a new knowledge collection in workspace
- [Query knowledge](https://docs.inworld.ai/api-reference/knowledgeAPI/knowledgeservice/query-knowledge): Query knowledge collections for relevant information
- [Get knowledge](https://docs.inworld.ai/api-reference/knowledgeAPI/knowledgeservice/get-knowledge): Retrieve a specific knowledge collection
- [List knowledge](https://docs.inworld.ai/api-reference/knowledgeAPI/knowledgeservice/list-knowledge): List all knowledge collections in workspace
- [Update knowledge](https://docs.inworld.ai/api-reference/knowledgeAPI/knowledgeservice/update-knowledge): Update an existing knowledge collection
- [Delete knowledge](https://docs.inworld.ai/api-reference/knowledgeAPI/knowledgeservice/delete-knowledge): Delete a knowledge collection

## Speech-to-Text APIs

### Speech to Text Service
- [Stream audio bytes to receive transcription text](https://docs.inworld.ai/api-reference/sttAPI/speechtotextservice/stream-audio-bytes-to-receive-transcription-text): Convert speech audio to text using streaming

## Embeddings APIs

### Embeddings Service
- [Create embeddings](https://docs.inworld.ai/api-reference/embeddingsAPI/createembeddings/create-embeddings): Generate text embeddings for similarity search and retrieval

## TTS APIs

### Text to Speech
- [Synthesize speech](https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/synthesize-speech): Receive results after all text input has been processed
- [Synthesize speech (stream)](https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/synthesize-speech-stream): Receive audio chunks as they are individually processed
- [Synthesize speech (websocket)](https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/synthesize-speech-websocket): Real-time speech synthesis via WebSocket connection
- [List voices](https://docs.inworld.ai/api-reference/ttsAPI/texttospeech/list-voices): List all available voices based on the provided filter