@juspay/neurolink 12.41.8 → 12.41.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -770,7 +770,7 @@
770
770
  {"objectID":"f007d6256ae9ce3cd888b757374cf819d6d20a2466de5280aa882385928dfa42","title":"Install globally","url":"/docs/cli/commands#install-globally","content":"npm install -g @juspay/neurolink","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Install globally","lvl3":""}},
771
771
  {"objectID":"fe8f683c688c22a4fb00ea52ec4f803cc988e40adedfb184ae651f06394d7d87","title":"Local project dependency","url":"/docs/cli/commands#local-project-dependency","content":"npm install @juspay/neurolink\n`","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Local project dependency","lvl3":""}},
772
772
  {"objectID":"6d0358f7c107fa0314373826a28ae5ced11a8739cb937a2e595a91d9b60e762c","title":"Command Map","url":"/docs/cli/commands#command-map","content":"| Command | Description | Example |\n| --------------------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |\n| generate / gen | One-shot content generation with optional multimodal input. | npx @juspay/neurolink generate \"Draft release notes\" --image ./before.png |\n| stream | Real-time streaming output with tool support. | npx @juspay/neurolink stream \"Narrate sprint demo\" --enableAnalytics |\n| decide [state] | Typed, calibrated judgements from a decision model (no free text). | npx @juspay/neurolink decide \"Refund request\" --questions '{\"urgent\":{\"type\":\"boolean\",\"instructions\":\"Is this urgent?\"}}' |\n| batch | Process multiple prompts from a file. | npx @juspay/neurolink batch prompts.txt --format json |\n| loop | Interactive session with persistent variables & memory. | npx @juspay/neurolink loop --auto-redis |\n| auth <subcommand> | Manage provider authentication (API key or OAuth). | npx @juspay/neurolink auth login anthropic --method oauth |\n| setup / s | Guided provider onboarding and validation. | npx @juspay/neurolink setup --provider openai |\n| status | Health che","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Command Map","lvl3":""}},
773
- {"objectID":"9e0214df07d3ce7a4f5c3d862435d771b4f9c080046e67804012b4d25065b2ee","title":"generate <input> {#generate}","url":"/docs/cli/commands#generate-input-generate","content":"Key flags:\n--provider, -p – provider slug (default auto).\n--model, -m – model name for the chosen provider.\n--image, -i – attach one or more image files/URLs for multimodal prompts.\n--pdf – attach one or more PDF files for document analysis.\n--csv, -c – attach one or more CSV files for data analysis.\n--file – attach any supported file type, auto-detected. Covers Office documents (Word .docx, Excel .xlsx/.xls, PowerPoint .pptx, RTF, OpenDocument), audio (.mp3, .wav, .m4a, … — transcribed automatically), video (.mp4, .webm, .mov, .mkv — keyframes plus metadata and any embedded subtitles), archives, JSON, YAML, XML, HTML, SVG, Markdown, and 50+ code languages. Repeatable. Not available on batch, where it would collide with the prompts-file positional — use generate or stream.\n--temperature, -t – creativity (default 0.7).\n--maxTokens, --max – response limit (default 1000).\n--system, -s – system prompt.\n--format, -f, --output-format – text (default), json, or table. With json, stdout carries only the JSON result; debug and info logs go to stderr, so the output stays parseable even with --debug.\n--output, -o – write response to file.\n--imageOutput, --image-output – custom path for generated image (default: generated-images/image-<timestamp>.png).\n--enableAnalytics / --enableEvaluation – capture metrics & quality scores.\n--evaluationDomain – domain hint for the judge model.\n--domainAware – use domain-aware evaluation (default false).\n--context – JSON string appended to analytics/evaluation context.\n--domain, -d – domain type for specialized processing: healthcare, finance, analytics, ecommerce, education, legal, technology, generic, auto.\n--disableTools – bypass MCP tools for this call.\n--timeout – seconds before aborting the request (default 120).\n--region, -r – Vertex AI region (e.g., us-central1, europe-west1, asia-northeast1).\n--debug, -v, --verbose – verbose logging and full JSON payloads.\n--quiet, -q – suppress non-essential output (default true).\n\nCSV Options:\n--csv","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"generate <input> {#generate}","lvl3":""}},
773
+ {"objectID":"b149865b2facf38f974af3ecc7a0bfaee49be27a20c207ed01c32b26247fd099","title":"generate <input>","url":"/docs/cli/commands#generate","content":"Key flags:\n--provider, -p – provider slug (default auto).\n--model, -m – model name for the chosen provider.\n--image, -i – attach one or more image files/URLs for multimodal prompts.\n--pdf – attach one or more PDF files for document analysis.\n--csv, -c – attach one or more CSV files for data analysis.\n--file – attach any supported file type, auto-detected. Covers Office documents (Word .docx, Excel .xlsx/.xls, PowerPoint .pptx, RTF, OpenDocument), audio (.mp3, .wav, .m4a, … — transcribed automatically), video (.mp4, .webm, .mov, .mkv — keyframes plus metadata and any embedded subtitles), archives, JSON, YAML, XML, HTML, SVG, Markdown, and 50+ code languages. Repeatable. Not available on batch, where it would collide with the prompts-file positional — use generate or stream.\n--temperature, -t – creativity (default 0.7).\n--maxTokens, --max – response limit (default 1000).\n--system, -s – system prompt.\n--format, -f, --output-format – text (default), json, or table. With json, stdout carries only the JSON result; debug and info logs go to stderr, so the output stays parseable even with --debug.\n--output, -o – write response to file.\n--imageOutput, --image-output – custom path for generated image (default: generated-images/image-<timestamp>.png).\n--enableAnalytics / --enableEvaluation – capture metrics & quality scores.\n--evaluationDomain – domain hint for the judge model.\n--domainAware – use domain-aware evaluation (default false).\n--context – JSON string appended to analytics/evaluation context.\n--domain, -d – domain type for specialized processing: healthcare, finance, analytics, ecommerce, education, legal, technology, generic, auto.\n--disableTools – bypass MCP tools for this call.\n--timeout – seconds before aborting the request (default 120).\n--region, -r – Vertex AI region (e.g., us-central1, europe-west1, asia-northeast1).\n--debug, -v, --verbose – verbose logging and full JSON payloads.\n--quiet, -q – suppress non-essential output (default true).\n\nCSV Options:\n--csv","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"generate <input>","lvl3":""}},
774
774
  {"objectID":"621800e7302c71eae24c4286bcb9e05a8e110cf656e2a2d339bd8ecbe998d32e","title":"Generate with explicit subscription tier","url":"/docs/cli/commands#generate-with-explicit-subscription-tier","content":"npx @juspay/neurolink generate \"Explain quantum computing\" \\\n --provider anthropic --subscription-tier pro","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Generate with explicit subscription tier","lvl3":""}},
775
775
  {"objectID":"ad3c3b350fe961788a9aad769e12752ba4a17c25fbc14e3aeec6374cfb865d0c","title":"Generate with OAuth auth method","url":"/docs/cli/commands#generate-with-oauth-auth-method","content":"npx @juspay/neurolink generate \"Write a poem\" \\\n --provider anthropic --authMethod oauth --enableBeta","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Generate with OAuth auth method","lvl3":""}},
776
776
  {"objectID":"e10205dca3731c8d19a1bad6da55856d73395d3512b695b335cffbb198d8498b","title":"Stream with max tier","url":"/docs/cli/commands#stream-with-max-tier","content":"npx @juspay/neurolink stream \"Tell me a story\" \\\n --provider anthropic --subscriptionTier max\nbash","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Stream with max tier","lvl3":""}},
@@ -779,17 +779,17 @@
779
779
  {"objectID":"ced310f1b6c269511afb6ce948650a980f7ad27c98508884bfe3f90b3759a09f","title":"Generate a presentation","url":"/docs/cli/commands#generate-a-presentation","content":"npx @juspay/neurolink generate \"Quarterly business review for Q4 2025\" \\\n --outputMode ppt --pptPages 15 --pptTheme corporate --pptOutput ./q4-review.pptx","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Generate a presentation","lvl3":""}},
780
780
  {"objectID":"50f5ba2e2435cf33ad1ded331cfb0f7c8eae5ef3ebc37417af7abf317760a2ce","title":"Generate with audience and tone","url":"/docs/cli/commands#generate-with-audience-and-tone","content":"npx @juspay/neurolink generate \"Introduction to machine learning\" \\\n --pptPages 20 --pptAudience students --pptTone educational --pptOutput ./ml-intro.pptx","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Generate with audience and tone","lvl3":""}},
781
781
  {"objectID":"f2af75a1446c83bb27c1724b2e40e0fb3e603b2e831beb84891b10e1215af416","title":"Minimal presentation without AI images","url":"/docs/cli/commands#minimal-presentation-without-ai-images","content":"npx @juspay/neurolink generate \"Project status update\" \\\n --outputMode ppt --pptNoImages --pptOutput ./status.pptx\n\n\ngen` is a short alias with the same options.","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Minimal presentation without AI images","lvl3":""}},
782
- {"objectID":"117773e42d8af865d4b220619b88760164a39e0e143fc65efbbb2ba3db723032","title":"stream <input> {#stream}","url":"/docs/cli/commands#stream-input-stream","content":"stream shares the same flags as generate and adds chunked output for live UIs. Evaluation results are emitted after the stream completes when --enableEvaluation is set.","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"stream <input> {#stream}","lvl3":""}},
783
- {"objectID":"112fba73837b247878d2a9e5e27da20722703f27b30aec829b7a5e7a35fa4907","title":"decide [state] {#decide}","url":"/docs/cli/commands#decide-state-decide","content":"Get typed, calibrated judgements from a decision model — the decide inference type, alongside generate and stream. Takes one state plus a map of named typed questions and prints one answer per question; there is no free text anywhere in the response.\n\n`bash","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"decide [state] {#decide}","lvl3":""}},
782
+ {"objectID":"7ec85e0656bd3eb179cbc2ba3cc248046c955160bd6193952a4918f84537a931","title":"stream <input>","url":"/docs/cli/commands#stream","content":"stream shares the same flags as generate and adds chunked output for live UIs. Evaluation results are emitted after the stream completes when --enableEvaluation is set.","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"stream <input>","lvl3":""}},
783
+ {"objectID":"6df70184b50cfe765cb953c7f99da86bcc5085d7c1bd9c009ad1d936cd313d54","title":"decide [state]","url":"/docs/cli/commands#decide","content":"Get typed, calibrated judgements from a decision model — the decide inference type, alongside generate and stream. Takes one state plus a map of named typed questions and prints one answer per question; there is no free text anywhere in the response.\n\n`bash","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"decide [state]","lvl3":""}},
784
784
  {"objectID":"0076ed0bb97c3c91b6019b1168d3de94687353bc588fc474812ff9a55bf325d3","title":"State as a positional argument","url":"/docs/cli/commands#state-as-a-positional-argument","content":"npx @juspay/neurolink decide \"Refund request for a damaged item\" \\\n --questions '{\"urgent\":{\"type\":\"boolean\",\"instructions\":\"Is this urgent?\"}}'","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"State as a positional argument","lvl3":""}},
785
785
  {"objectID":"e7605e932a3b0b4ce109cdb2cbb0d1d5012cb18891ee886ed14d4873544bd69e","title":"State and questions from files, raw JSON output","url":"/docs/cli/commands#state-and-questions-from-files-raw-json-output","content":"npx @juspay/neurolink decide --state-file ticket.json \\\n --questions-file questions.json --format json","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"State and questions from files, raw JSON output","lvl3":""}},
786
786
  {"objectID":"a2363c0f4f7fce94452a1c2875ce15d2767aa37fd4a21a4a030393bd811191b9","title":"Ask about an image (XOR only); repeat --image for several, or use --video","url":"/docs/cli/commands#ask-about-an-image-xor-only-repeat---image-for-several-or-use---video","content":"npx @juspay/neurolink decide \"What color is this?\" --provider xor \\\n --image ./photo.png \\\n --questions '{\"color\":{\"type\":\"choice\",\"instructions\":\"What color is the image?\",\"criteria\":{\"red\":\"red\",\"blue\":\"blue\"}}}'\n\n\n| Option | Description |\n| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| state | The content to judge, as a positional argument (or use --state-file). |\n| --state-file | Path to a file holding the state (plain text or JSON). |\n| --questions | Inline JSON map of questions. Exactly one of this or --questions-file. |\n| --questions-file | Path to a JSON file holding the questions map. |\n| --provider | Decision provider to use: typesafe, laya or xor. Defaults to the first configured, in that order (TypeSafe, Laya, XOR). |\n| --model | Overrides the provider's configured model for this call. |\n| --image | An image for the model to read, as a file path or a data: URL. Repeat the flag for several (XOR takes up to 8). |\n| --video | One video for the model to read (MP4, MOV or WebM), as a file path or a data: URL. Prefer one kind of media per request. |\n| --timeout | Timeout in milliseconds. |\n| --format text\\|json, -f | Output format (default: text). With json, stdout carries only the resul","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Ask about an image (XOR only); repeat --image for several, or use --video","lvl3":""}},
787
- {"objectID":"7b43d630a9f7ed5a224fe8887281efede99fe513e10cd3d1322dfb30ded920b0","title":"batch <file> {#batch}","url":"/docs/cli/commands#batch-file-batch","content":"Process multiple prompts from a file in sequence.\n\n`bash","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"batch <file> {#batch}","lvl3":""}},
787
+ {"objectID":"c8d0c91cc9a6c43b1ffaf7778b1b847d0082ea6ac5b07bef70f901690fab3f2d","title":"batch <file>","url":"/docs/cli/commands#batch","content":"Process multiple prompts from a file in sequence.\n\n`bash","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"batch <file>","lvl3":""}},
788
788
  {"objectID":"7295bf29c7231cdfbc08cfe63fa54bdd96d158a2f3d4ffb093a8d86826c42abf","title":"Process prompts from a file","url":"/docs/cli/commands#process-prompts-from-a-file","content":"npx @juspay/neurolink batch prompts.txt","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Process prompts from a file","lvl3":""}},
789
789
  {"objectID":"f5a81a31f8f017423e190eed5892ad06dbeb9bc3d55c3224a9e34909c9332aad","title":"Export results as JSON","url":"/docs/cli/commands#export-results-as-json","content":"npx @juspay/neurolink batch questions.txt --format json","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Export results as JSON","lvl3":""}},
790
790
  {"objectID":"fc941fb5f124a9e9211d96a9f02d205ab9720989280ad2db3f18bc7df03c43d0","title":"Use Vertex AI with 2s delay between requests","url":"/docs/cli/commands#use-vertex-ai-with-2s-delay-between-requests","content":"npx @juspay/neurolink batch tasks.txt -p vertex --delay 2000","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Use Vertex AI with 2s delay between requests","lvl3":""}},
791
791
  {"objectID":"1607a41981c5f29a45ce1c6b397a86985f7646e89283932af2c687f36c04c3b3","title":"Save results to file","url":"/docs/cli/commands#save-results-to-file","content":"npx @juspay/neurolink batch batch.txt --output results.json\n\n\nbatch shares the same flags as generate. The input file should contain one prompt per line. Results are returned as an array of { prompt, response } objects. A default 1-second delay is applied between requests; override with --delay `.","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Save results to file","lvl3":""}},
792
- {"objectID":"262a8eb378a013213f5644b35b29c8f374e1cf844b22aa960b8c08cb70441d1f","title":"Model Evaluation {#eval}","url":"/docs/cli/commands#model-evaluation-eval","content":"Evaluate AI model outputs for quality, accuracy, and safety using NeuroLink's built-in evaluation engine.\n\nVia generate/stream commands:\n\n`bash","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Model Evaluation {#eval}","lvl3":""}},
792
+ {"objectID":"8e2c84d7b671a8ec8611e9fb67b96c500b15b26543791671fe6666bff1ea7676","title":"Model Evaluation","url":"/docs/cli/commands#eval","content":"Evaluate AI model outputs for quality, accuracy, and safety using NeuroLink's built-in evaluation engine.\n\nVia generate/stream commands:\n\n`bash","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Model Evaluation","lvl3":""}},
793
793
  {"objectID":"875afffdaade112a347cb8bc32a3159e4e906bac9be60d54b8a8e26a4e126287","title":"Enable evaluation on any command","url":"/docs/cli/commands#enable-evaluation-on-any-command","content":"npx @juspay/neurolink generate \"Write a product description\" \\\n --enableEvaluation \\\n --evaluationDomain \"e-commerce\"\njson\n{\n \"response\": \"...\",\n \"evaluation\": {\n \"score\": 0.85,\n \"metrics\": {\n \"accuracy\": 0.9,\n \"safety\": 1.0,\n \"relevance\": 0.8\n },\n \"judge_model\": \"gpt-4o\",\n \"feedback\": \"High quality response with clear structure\"\n }\n}\n\n\n**Key Evaluation Flags:**\n\n- --enableEvaluation – Activate quality scoring\n- --evaluationDomain – Context hint for the judge (e.g., \"medical\", \"legal\", \"technical\")\n- --context ` – Additional context for evaluation\n\nJudge Models:\n\nNeuroLink uses GPT-4o by default as the judge model, but you can configure different models for evaluation in your SDK configuration.\n\nUse Cases:\nQuality assurance for production outputs\nA/B testing different prompts\nSafety validation before deployment\nCompliance checking for regulated industries\n\nLearn more: Auto Evaluation Guide","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Enable evaluation on any command","lvl3":""}},
794
794
  {"objectID":"56f116fe9ff6e3420be04edbed667775c1f70f0964d27fdba227209e8105707f","title":"loop","url":"/docs/cli/commands#loop","content":"Interactive session mode with persistent state, conversation memory, and session variables. Perfect for iterative workflows and experimentation.\n\n`bash","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"loop","lvl3":""}},
795
795
  {"objectID":"5a98690a1df66dac7cbd5296b3e985506cf412a4476c57b01062d65bca2db074","title":"Start loop with Redis-backed conversation memory","url":"/docs/cli/commands#start-loop-with-redis-backed-conversation-memory","content":"npx @juspay/neurolink loop --enable-conversation-memory --auto-redis","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Start loop with Redis-backed conversation memory","lvl3":""}},
@@ -798,7 +798,7 @@
798
798
  {"objectID":"cdcfa2bae4a72c63907c2e125e19c2783739e93cb480ac060749ca8798af308e","title":"Resume a specific conversation by session ID","url":"/docs/cli/commands#resume-a-specific-conversation-by-session-id","content":"npx @juspay/neurolink loop --resume abc123def456","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Resume a specific conversation by session ID","lvl3":""}},
799
799
  {"objectID":"11e4f954dad19caf422ba4bf196da111ed3b6e559617c63481941716f26a673c","title":"List available conversations and exit","url":"/docs/cli/commands#list-available-conversations-and-exit","content":"npx @juspay/neurolink loop --list-conversations","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"List available conversations and exit","lvl3":""}},
800
800
  {"objectID":"9fb716615356c3bb21d44d8a1cd949e56eb10db3e4fefbee571ae1ed81ca3acc","title":"Use in-memory storage only","url":"/docs/cli/commands#use-in-memory-storage-only","content":"npx @juspay/neurolink loop --no-auto-redis\n\n Context usage: 83% of window (12,450 / 15,000 tokens)\n Auto-compaction will trigger to preserve conversation quality.\n \n When --disable-compaction` is not set, the system automatically compacts the context to free up space while preserving conversation quality.\n\nSee the complete guide: CLI Loop Sessions","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Use in-memory storage only","lvl3":""}},
801
- {"objectID":"31741ba6ff85f22428da87c015b5012f1876f0dd0ac61370d5ee4e700a9dc7d0","title":"auth <subcommand> {#auth}","url":"/docs/cli/commands#auth-subcommand-auth","content":"Manage authentication with AI providers. Supports traditional API key authentication and OAuth 2.1 with PKCE for Claude subscription plans (Pro/Max).\n\n`bash","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"auth <subcommand> {#auth}","lvl3":""}},
801
+ {"objectID":"60fe95e7585415fcb97694f12eabe0d12bbde39d6643da72ef2040f0a8cad6e4","title":"auth <subcommand>","url":"/docs/cli/commands#auth","content":"Manage authentication with AI providers. Supports traditional API key authentication and OAuth 2.1 with PKCE for Claude subscription plans (Pro/Max).\n\n`bash","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"auth <subcommand>","lvl3":""}},
802
802
  {"objectID":"d42dd58f85a6dac8b83bd7c8f1b949ba351f02ebce27569579adaf89f0661c77","title":"Interactive login (prompts for authentication method)","url":"/docs/cli/commands#interactive-login-prompts-for-authentication-method","content":"npx @juspay/neurolink auth login anthropic","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Interactive login (prompts for authentication method)","lvl3":""}},
803
803
  {"objectID":"06f83203673f1b610a1d661731488f66bc12ae5b4dc9a85b14cc66d41a96e2f2","title":"Login with a specific method","url":"/docs/cli/commands#login-with-a-specific-method","content":"npx @juspay/neurolink auth login anthropic --method api-key\nnpx @juspay/neurolink auth login anthropic --method oauth\nnpx @juspay/neurolink auth login anthropic --method create-api-key","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Login with a specific method","lvl3":""}},
804
804
  {"objectID":"afe697c8075445d2cb91805314218e2b23aec25cd6d212250695527eefa59d53","title":"Check authentication status for all providers","url":"/docs/cli/commands#check-authentication-status-for-all-providers","content":"npx @juspay/neurolink auth status","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Check authentication status for all providers","lvl3":""}},
@@ -844,7 +844,7 @@
844
844
  {"objectID":"b0b1970eb3114d13fb4e140b7ba816eb225ec7bda9b08070a738e8ba7615d04b","title":"Add custom servers with different transports","url":"/docs/cli/commands#add-custom-servers-with-different-transports","content":"npx @juspay/neurolink mcp add myserver \"python server.py\" --transport stdio\nnpx @juspay/neurolink mcp add webserver \"node server.js\" --transport sse","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Add custom servers with different transports","lvl3":""}},
845
845
  {"objectID":"81336a10bacbc44d3547931d1107de6094e42251a72ee5e042d9e19912ca12f8","title":"Test server connectivity","url":"/docs/cli/commands#test-server-connectivity","content":"npx @juspay/neurolink mcp test myserver","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Test server connectivity","lvl3":""}},
846
846
  {"objectID":"32741de064f25af94f910c5995656b84260c845eab86c9602f22d8fab874f252","title":"Remove a server","url":"/docs/cli/commands#remove-a-server","content":"npx @juspay/neurolink mcp remove myserver\n\n\n**MCP Command Options (mcp add):**\n\n| Option | Description |\n| ------------- | --------------------------------------------------- |\n| --transport | Transport type: stdio, http, sse, websocket |\n| --args | Command arguments (array) |\n| --env` | Environment variables (JSON string) |\n\nHTTP Transport Features:\nCustom headers for authentication (Bearer tokens, API keys)\nConfigurable timeouts and connection options\nAutomatic retry with exponential backoff\nRate limiting to prevent API throttling\nOAuth 2.1 support with PKCE\n\nSee MCP HTTP Transport Guide for complete configuration options.","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Remove a server","lvl3":""}},
847
- {"objectID":"c8d0c91cc9a6c43b1ffaf7778b1b847d0082ea6ac5b07bef70f901690fab3f2d","title":"batch","url":"/docs/cli/commands#batch","content":"See batch <file> above.","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"batch","lvl3":""}},
847
+ {"objectID":"818b47cad90507b91e1ece0284c473fbca10a1df4b96c83701b6027487dfbe23","title":"batch","url":"/docs/cli/commands#batch","content":"See batch <file> above.","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"batch","lvl3":""}},
848
848
  {"objectID":"3ff51731b288761a7fdcd55b3d1612c08bfc16223f2dfea075e04b8181ad338b","title":"get-best-provider","url":"/docs/cli/commands#get-best-provider","content":"Show the best available AI provider based on current configuration and availability.\n\n`bash","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"get-best-provider","lvl3":""}},
849
849
  {"objectID":"9e2573fd4d079d63ccd6bfe6fefe1869541517e038195b28ba89290eab44b68f","title":"Get best available provider","url":"/docs/cli/commands#get-best-available-provider","content":"npx @juspay/neurolink get-best-provider","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Get best available provider","lvl3":""}},
850
850
  {"objectID":"66b34aaaa0c006cc416856522e091be34abfa70eb5e8f164a7f7ea06f6763122","title":"Get provider as JSON","url":"/docs/cli/commands#get-provider-as-json","content":"npx @juspay/neurolink get-best-provider --format json","hierarchy":{"lvl0":"Cli","lvl1":"CLI Command Reference","lvl2":"Get provider as JSON","lvl3":""}},
@@ -3862,9 +3862,9 @@
3862
3862
  {"objectID":"58b3d361e91f40985729c568ce2b68260730fafac985ed726083beb3bdd32256","title":"See Also","url":"/docs/features/memory#see-also","content":"Conversation Memory - Session-based conversation history\nMemory Integration - Advanced hippocampus configuration and patterns\nContext Compaction - Automatic context window management\nContext Summarization - Conversation compression","hierarchy":{"lvl0":"Features","lvl1":"Memory Guide","lvl2":"See Also","lvl3":""}},
3863
3863
  {"objectID":"c07221ea62db3c1a2b47f2d540dfef04563cd63dda1cb4ecef74e86e0941d6cd","title":"Multimodal Chat Experiences","url":"/docs/features/multimodal-chat","content":"Multimodal Chat Experiences\n\nNeuroLink provides full multimodal pipelines so you can mix text, URLs, and local images in a single interaction. The CLI, SDK, and loop sessions all use the same message builder, ensuring parity across workflows.\n\nVideo Generation {#video-generation}\n\nNeuroLink supports video generation from images using Google's Veo 3.1 model via Vertex AI. Transform static images into 8-second videos with synchronized audio.\n\nSee: Video Generation Guide for complete documentation.\n\nPPT Generation {#ppt-generation}\n\nNeuroLink supports AI-powered PowerPoint generation from text prompts. Create professional presentations with 35 slide types, 5 themes, and optional AI-generated images.\n\nSee: PPT Generation Guide for complete documentation.\n\nImages {#images}\n\nNeuroLink provides comprehensive image support across all vision-capable providers. Images can be provided as local file paths, HTTPS URLs, or Buffer objects, and are automatically converted to the provider's required encoding format.\n\nWhat You Get\nUnified CLI flag – --image accepts multiple file paths or HTTPS URLs per request.\nSDK parity – pass input.images (buffers, file paths, or URLs) and stream structured outputs.\nProvider fallbacks – orchestration automatically retries compatible multimodal models.\nStreaming support – neurolink stream renders partial responses while images upload in the background.\n\nThe image input accepts three formats: Buffer objects (from readFileSync), local file paths (relative or absolute), or HTTPS URLs. All formats are automatically converted to the provider's required encoding.\n\nSupported Providers & Models\n\nNot all providers support multimodal inputs. Verify your chosen model has the vision capability using npx @juspay/neurolink models list --capability vision. Unsupported providers will return an error or ignore image inputs.\n\n| Provider | Recommended Models | Notes |\n| ---------------------- | ---------------------------------------- | --------------------------------------------------------- |\n| google-ai, vertex | gemini-2.5-pro, gemini-2.5-flash | Local files and URLs supported. |\n| openai, azure | gpt-4o, gpt-4o-mini | Requires OPENAI_API_KEY or Azure deployment name + key. |\n| anthropic, bedrock | claude-3.5-sonnet, claude-3.7-sonnet | Bedrock needs region + credentials. |\n| litellm | Any upstream multimodal model | Ensure LiteLLM server exposes vision capability. |\n\nUse npx @juspay/neurolink models list --capability vision to see the full list from config/models.json.\n\nPrerequisites\nProvider credentials with vision/multimodal permissions.\nLatest CLI (npm, pnpm, or npx) or SDK.\nOptional: Redis if you want images stored alongside loop-session history.\n\nCLI Quick Start\n\nStreaming & Loop Sessions\n\nSDK Usage\nEnable provider orchestration for automatic multimodal fallbacks\nText prompt describing what you want from the images\nArray of images in multiple formats\nLocal file as Buffer (auto-converted to base64)\nRemote URL (downloaded and encoded automatically)\nChoose a vision-capable provider\nOptionally evaluate the quality of multimodal responses\n\nImage Alt Text for Accessibility\n\nNeuroLink supports alt text for images, which is helpful for accessibility (screen readers) and providing additional context to AI models. Alt text is automatically included as context in the prompt sent to AI providers.\nImages can be objects with data and altText properties\nAlt text for local file - helps AI understand the image context\nAlt text for remote URL - provides additional context for accessibility\n\nYou can also mix simple images with alt-text-enabled images:\n\nKeep alt text concise but descriptive (under 125 characters is ideal)\nFocus on the key information the image conveys\nAlt text is automatically included as context in the prompt, helping AI models better understand the images\n :::\n\nUse stream() with the same structure when you need incremental tokens:\nAccepts file path, Buffer, or HTTPS URL\nOpenAI's GPT-4o and GPT-4o-mini support vision\nStream text responses while image uploads in background\n\nConfiguration & Tuning\nImage sources – Local paths are resolved relative to process.cwd(). URLs must be HTTPS.\nSize limits – Providers cap images at ~20 MB. Resize or compress large assets before sending.\nMultiple images – Order matters; the builder interleaves captions in the order provided.\nRegion routing – Set region on each request (e.g., us-east-1) for providers that enforce locality.\nLoop sessions – Images uploaded during loop are cached per session; call clear session to reset.\nAlt text – Add alt text to images for accessibility; the text is included as context for AI models.\n\nBest Practices\nProvide short captions in the prompt describing each image (e.g., \"see before.png on the left\").\nUse alt text for images that convey important ","hierarchy":{"lvl0":"Features","lvl1":"Multimodal Chat Experiences","lvl2":"","lvl3":""}},
3864
3864
  {"objectID":"4660ba8c07ff51115ed9aa6c87a424bfd5b8b0f54e27ce28ac6875a5560e1c25","title":"Multimodal Chat Experiences","url":"/docs/features/multimodal-chat#multimodal-chat-experiences","content":"NeuroLink provides full multimodal pipelines so you can mix text, URLs, and local images in a single interaction. The CLI, SDK, and loop sessions all use the same message builder, ensuring parity across workflows.","hierarchy":{"lvl0":"Features","lvl1":"Multimodal Chat Experiences","lvl2":"Multimodal Chat Experiences","lvl3":""}},
3865
- {"objectID":"b073041bff82226206649452437d80972822ba015264eef7ce77994e96d92d37","title":"Video Generation {#video-generation}","url":"/docs/features/multimodal-chat#video-generation-video-generation","content":"NeuroLink supports video generation from images using Google's Veo 3.1 model via Vertex AI. Transform static images into 8-second videos with synchronized audio.\n\nSee: Video Generation Guide for complete documentation.","hierarchy":{"lvl0":"Features","lvl1":"Multimodal Chat Experiences","lvl2":"Video Generation {#video-generation}","lvl3":""}},
3866
- {"objectID":"639378757f850c9355fc0afc54914a750f16bf1f60bf578ac2b70ebf6daeef90","title":"PPT Generation {#ppt-generation}","url":"/docs/features/multimodal-chat#ppt-generation-ppt-generation","content":"NeuroLink supports AI-powered PowerPoint generation from text prompts. Create professional presentations with 35 slide types, 5 themes, and optional AI-generated images.\n\nSee: PPT Generation Guide for complete documentation.","hierarchy":{"lvl0":"Features","lvl1":"Multimodal Chat Experiences","lvl2":"PPT Generation {#ppt-generation}","lvl3":""}},
3867
- {"objectID":"c4abd887668f5215d6562dbb60f9c2c931d882c9aa7a18d4bc42c0a51d2f9917","title":"Images {#images}","url":"/docs/features/multimodal-chat#images-images","content":"NeuroLink provides comprehensive image support across all vision-capable providers. Images can be provided as local file paths, HTTPS URLs, or Buffer objects, and are automatically converted to the provider's required encoding format.","hierarchy":{"lvl0":"Features","lvl1":"Multimodal Chat Experiences","lvl2":"Images {#images}","lvl3":""}},
3865
+ {"objectID":"803ac5330bf8e75d40d76e9e663d67c06e59b49b136f2ad1a8c60d52f5c718cb","title":"Video Generation","url":"/docs/features/multimodal-chat#video-generation","content":"NeuroLink supports video generation from images using Google's Veo 3.1 model via Vertex AI. Transform static images into 8-second videos with synchronized audio.\n\nSee: Video Generation Guide for complete documentation.","hierarchy":{"lvl0":"Features","lvl1":"Multimodal Chat Experiences","lvl2":"Video Generation","lvl3":""}},
3866
+ {"objectID":"75834b515f6d960404b821e5f612a8aaa3d45dc027668cc8b395c1899f300002","title":"PPT Generation","url":"/docs/features/multimodal-chat#ppt-generation","content":"NeuroLink supports AI-powered PowerPoint generation from text prompts. Create professional presentations with 35 slide types, 5 themes, and optional AI-generated images.\n\nSee: PPT Generation Guide for complete documentation.","hierarchy":{"lvl0":"Features","lvl1":"Multimodal Chat Experiences","lvl2":"PPT Generation","lvl3":""}},
3867
+ {"objectID":"48d2f202cf74316f3e438f135fb1377ec1b0ffd81a1d98c8e3df6b33c68371c4","title":"Images","url":"/docs/features/multimodal-chat#images","content":"NeuroLink provides comprehensive image support across all vision-capable providers. Images can be provided as local file paths, HTTPS URLs, or Buffer objects, and are automatically converted to the provider's required encoding format.","hierarchy":{"lvl0":"Features","lvl1":"Multimodal Chat Experiences","lvl2":"Images","lvl3":""}},
3868
3868
  {"objectID":"95bf7d40ed585b4298981335cc89b7ca59aeb36931662f1a54fcdbff42147a75","title":"What You Get","url":"/docs/features/multimodal-chat#what-you-get","content":"Unified CLI flag – --image accepts multiple file paths or HTTPS URLs per request.\nSDK parity – pass input.images (buffers, file paths, or URLs) and stream structured outputs.\nProvider fallbacks – orchestration automatically retries compatible multimodal models.\nStreaming support – neurolink stream renders partial responses while images upload in the background.\n\nThe image input accepts three formats: Buffer objects (from readFileSync), local file paths (relative or absolute), or HTTPS URLs. All formats are automatically converted to the provider's required encoding.","hierarchy":{"lvl0":"Features","lvl1":"Multimodal Chat Experiences","lvl2":"What You Get","lvl3":""}},
3869
3869
  {"objectID":"b1b6a1fd9bdbebfe4dbce1dd0d619d6d2ed6cf91720ba1ca80312d7b9773912c","title":"Supported Providers & Models","url":"/docs/features/multimodal-chat#supported-providers-models","content":"Not all providers support multimodal inputs. Verify your chosen model has the vision capability using npx @juspay/neurolink models list --capability vision. Unsupported providers will return an error or ignore image inputs.\n\n| Provider | Recommended Models | Notes |\n| ---------------------- | ---------------------------------------- | --------------------------------------------------------- |\n| google-ai, vertex | gemini-2.5-pro, gemini-2.5-flash | Local files and URLs supported. |\n| openai, azure | gpt-4o, gpt-4o-mini | Requires OPENAI_API_KEY or Azure deployment name + key. |\n| anthropic, bedrock | claude-3.5-sonnet, claude-3.7-sonnet | Bedrock needs region + credentials. |\n| litellm | Any upstream multimodal model | Ensure LiteLLM server exposes vision capability. |\n\nUse npx @juspay/neurolink models list --capability vision to see the full list from config/models.json.","hierarchy":{"lvl0":"Features","lvl1":"Multimodal Chat Experiences","lvl2":"Supported Providers & Models","lvl3":""}},
3870
3870
  {"objectID":"1eaa8387497d5e3b634d4592ce80309102daf4e9a8f4cc420069894df0ee5259","title":"Prerequisites","url":"/docs/features/multimodal-chat#prerequisites","content":"Provider credentials with vision/multimodal permissions.\nLatest CLI (npm, pnpm, or npx) or SDK.\nOptional: Redis if you want images stored alongside loop-session history.","hierarchy":{"lvl0":"Features","lvl1":"Multimodal Chat Experiences","lvl2":"Prerequisites","lvl3":""}},
@@ -4968,7 +4968,7 @@
4968
4968
  {"objectID":"b46488b02c1c2e88e3927e60a87df0c66044b3b92cef2a74d1e90908733563a7","title":"Prerequisites","url":"/docs/getting-started/provider-setup#prerequisites","content":"SageMaker Endpoint: Deploy a model to SageMaker and get the endpoint name\nAWS IAM Permissions: Ensure your credentials have sagemaker:InvokeEndpoint permission\nEndpoint Status: Endpoint must be in \"InService\" status","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Prerequisites","lvl3":""}},
4969
4969
  {"objectID":"3c395f3295fc6e7ca011b13d2ae650bbc58c6294c828a406d7d963b810e7d112","title":"Environment Variables Reference","url":"/docs/getting-started/provider-setup#environment-variables-reference","content":"| Variable | Required | Default | Description |\n| ---------------------------- | -------- | --------- | ------------------------- |\n| AWS_ACCESS_KEY_ID | ✅ | - | AWS access key |\n| AWS_SECRET_ACCESS_KEY | ✅ | - | AWS secret key |\n| AWS_REGION | ✅ | us-east-1 | AWS region |\n| SAGEMAKER_DEFAULT_ENDPOINT | ✅ | - | SageMaker endpoint name |\n| SAGEMAKER_TIMEOUT | ❌ | 30000 | Request timeout (ms) |\n| SAGEMAKER_MAX_RETRIES | ❌ | 3 | Retry attempts |\n| AWS_SESSION_TOKEN | ❌ | - | For temporary credentials |","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Environment Variables Reference","lvl3":""}},
4970
4970
  {"objectID":"be5f886d8eaff81cf2564a06bf8998a40a59120c426595f47a0482705dc3cfa4","title":"📖 Complete SageMaker Guide","url":"/docs/getting-started/provider-setup#-complete-sagemaker-guide","content":"For endpoint setup, permissions and production deployment:\n📖 Amazon SageMaker Provider Guide - Includes:\nModel endpoint deployment\nEnvironment and client configuration\nIAM policies and VPC connectivity\nFeature support (streaming, embeddings, tools, structured output)\nTroubleshooting","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"📖 Complete SageMaker Guide","lvl3":""}},
4971
- {"objectID":"42c25a94e2f407ae547a34d1bc31de542005830720662dc862edc7ec95e550b2","title":"Google Vertex AI Configuration {#vertex}","url":"/docs/getting-started/provider-setup#google-vertex-ai-configuration-vertex","content":"NeuroLink supports three authentication methods for Google Vertex AI to accommodate different deployment environments:","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Google Vertex AI Configuration {#vertex}","lvl3":""}},
4971
+ {"objectID":"1adad92fdc97851fcb82754ab7e562c95cfedaea32577568d04dbeb7a10d0419","title":"Google Vertex AI Configuration","url":"/docs/getting-started/provider-setup#vertex","content":"NeuroLink supports three authentication methods for Google Vertex AI to accommodate different deployment environments:","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Google Vertex AI Configuration","lvl3":""}},
4972
4972
  {"objectID":"490a21928554ec60701804793b44b0cd4a110db54bcb2de22bec3d3564b40933","title":"Method 1: Service Account File (Recommended for Production)","url":"/docs/getting-started/provider-setup#method-1-service-account-file-recommended-for-production","content":"Best for production environments where you can store service account files securely.\n\nSetup Steps:\nCreate a service account in Google Cloud Console\nDownload the service account JSON file\nSet the file path in GOOGLE_APPLICATION_CREDENTIALS","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Method 1: Service Account File (Recommended for Production)","lvl3":""}},
4973
4973
  {"objectID":"1a097bda015f26ad1789d0ea1d408cd0104d95f73a0a13e9d1256cf6e749ecab","title":"Method 2: Service Account JSON String (Good for Containers/Cloud)","url":"/docs/getting-started/provider-setup#method-2-service-account-json-string-good-for-containerscloud","content":"Best for containerized environments where file storage is limited.\n\nSetup Steps:\nCopy the entire contents of your service account JSON file\nSet it as a single-line string in GOOGLE_SERVICE_ACCOUNT_KEY\nNeuroLink will automatically create a temporary file for authentication","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Method 2: Service Account JSON String (Good for Containers/Cloud)","lvl3":""}},
4974
4974
  {"objectID":"e5a0bea92f35e99b7c28be4a5d044235f20825444a1f7a3b6686a6f92f62a0a3","title":"Method 3: Individual Environment Variables (Good for CI/CD)","url":"/docs/getting-started/provider-setup#method-3-individual-environment-variables-good-for-cicd","content":"Best for CI/CD pipelines where individual secrets are managed separately.\n\nSetup Steps:\nExtract client_email and private_key from your service account JSON\nSet them as individual environment variables\nNeuroLink will automatically assemble them into a temporary service account file","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Method 3: Individual Environment Variables (Good for CI/CD)","lvl3":""}},
@@ -4996,7 +4996,7 @@
4996
4996
  {"objectID":"d44785a74d53f490e16d03060286b30a0679091c742c21ee5057ecca6b2c1641","title":"Expected: vertex: ✅ Working (2599ms)","url":"/docs/getting-started/provider-setup#expected-vertex-working-2599ms","content":"`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Expected: vertex: ✅ Working (2599ms)","lvl3":""}},
4997
4997
  {"objectID":"2bc35d928d8002c76a1582aa2ff2e7a6f943d081c574f05d51492b4416c4d97b","title":"Google Cloud Setup Requirements","url":"/docs/getting-started/provider-setup#google-cloud-setup-requirements","content":"To use Google Vertex AI, ensure your Google Cloud project has:\nVertex AI API Enabled: Enable the Vertex AI API in your project\nService Account: Create a service account with Vertex AI permissions\nModel Access: Ensure access to the models you want to use\nBilling Enabled: Vertex AI requires an active billing account","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Google Cloud Setup Requirements","lvl3":""}},
4998
4998
  {"objectID":"c75e028006ddb9aad857d88478ffcb2ce444e0515acf96882d717373b2b43c9e","title":"Service Account Permissions","url":"/docs/getting-started/provider-setup#service-account-permissions","content":"Your service account needs these IAM roles:\nVertex AI User or Vertex AI Admin\nService Account Token Creator (if using impersonation)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Service Account Permissions","lvl3":""}},
4999
- {"objectID":"41af9698b4c8b486be0a273289b2a5eeaaa7dbb381c8d1a765d43ed54dbff295","title":"Google AI Studio Configuration {#google-ai}","url":"/docs/getting-started/provider-setup#google-ai-studio-configuration-google-ai","content":"Google AI Studio provides direct access to Google's Gemini models with a simple API key authentication.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Google AI Studio Configuration {#google-ai}","lvl3":""}},
4999
+ {"objectID":"b0840225519a76b9fbf914bd9320de07860bccd0503128be51fef575082e7d36","title":"Google AI Studio Configuration","url":"/docs/getting-started/provider-setup#google-ai","content":"Google AI Studio provides direct access to Google's Gemini models with a simple API key authentication.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Google AI Studio Configuration","lvl3":""}},
5000
5000
  {"objectID":"e381a6c9d13afff8a04ac00128e73f0cf43615b4ee62d2ebbd5b395db1c25afc","title":"Supported Models","url":"/docs/getting-started/provider-setup#supported-models-2","content":"gemini-2.5-pro - Comprehensive, detailed responses for complex tasks\ngemini-2.5-flash (recommended) - Fast, efficient responses for most tasks","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Models","lvl3":""}},
5001
5001
  {"objectID":"28ad498d224177dbe9a6fe74260d5b36c618e0c1c73068b460f5d5b2cbc1eb4c","title":"Timeout Configuration","url":"/docs/getting-started/provider-setup#timeout-configuration-4","content":"Default Timeout: 30 seconds\nSupported Formats: Milliseconds (30000), human-readable ('30s', '1m', '5m')\nEnvironment Variable: GOOGLE_AI_TIMEOUT='45s' (optional)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Timeout Configuration","lvl3":""}},
5002
5002
  {"objectID":"61fe16e0ef29bea0abed7b8dc8cd617374f5d94c9ec9ba124ed44e04568cf2a8","title":"How to Get Google AI Studio API Key","url":"/docs/getting-started/provider-setup#how-to-get-google-ai-studio-api-key","content":"Visit Google AI Studio: Go to aistudio.google.com\nSign In: Use your Google account credentials\nCreate API Key:\nNavigate to the API Keys section\nClick Create API Key\nCopy the generated key (starts with AIza)\nSet Environment: Add to your .env file or export directly","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"How to Get Google AI Studio API Key","lvl3":""}},
@@ -5037,7 +5037,7 @@
5037
5037
  {"objectID":"0f7df7689d157c8cf6a6cbe62a3a1d9cba61ebdb5a528bfdb647e4057565ced4","title":"Performance Optimization","url":"/docs/getting-started/provider-setup#performance-optimization","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Performance Optimization","lvl3":""}},
5038
5038
  {"objectID":"78f2b74dc0e268d7c0c6674a42019145a6ed1a5eabd8ad869542df4011b18b66","title":"Set memory limit","url":"/docs/getting-started/provider-setup#set-memory-limit","content":"OLLAMAMAXMEMORY=8GB ollama serve","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Set memory limit","lvl3":""}},
5039
5039
  {"objectID":"43e003ddeccd60ab6cfa5262bf459dc172e66b6f58804a1cae1f97d56592fa58","title":"Use specific GPU","url":"/docs/getting-started/provider-setup#use-specific-gpu","content":"OLLAMACUDADEVICE=0 ollama serve\n`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Use specific GPU","lvl3":""}},
5040
- {"objectID":"b6e9d44835d8d8ac2a7cb38509eb7845fdee45beb27982c6508eee36a8ae2194","title":"OpenRouter Configuration {#openrouter}","url":"/docs/getting-started/provider-setup#openrouter-configuration-openrouter","content":"OpenRouter provides access to 300+ AI models from 60+ providers through a single unified API with automatic failover and cost optimization.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"OpenRouter Configuration {#openrouter}","lvl3":""}},
5040
+ {"objectID":"7c44b94cef019cf343c4cfc7bcc899ca9a0bd1ee51bc3a8db03c42dcc2fee6a3","title":"OpenRouter Configuration","url":"/docs/getting-started/provider-setup#openrouter","content":"OpenRouter provides access to 300+ AI models from 60+ providers through a single unified API with automatic failover and cost optimization.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"OpenRouter Configuration","lvl3":""}},
5041
5041
  {"objectID":"a965744471dcee397ebdbe607603d9bbf28c7cab48191520e5a6daa26086b9e4","title":"Optional Configuration","url":"/docs/getting-started/provider-setup#optional-configuration-4","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Optional Configuration","lvl3":""}},
5042
5042
  {"objectID":"3a2996c7ecac322852306a78c9a06ccc42b4e7d24a3546687be172f54955e608","title":"Default model","url":"/docs/getting-started/provider-setup#default-model","content":"`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Default model","lvl3":""}},
5043
5043
  {"objectID":"cc23ed79bf6044263a7139f28be6e3de1d78efdc955ef8e5d216762cbf72e99e","title":"Supported Models","url":"/docs/getting-started/provider-setup#supported-models-3","content":"OpenRouter supports 300+ models including:\nanthropic/claude-3-5-sonnet (default) - Best overall quality\nopenai/gpt-4o - Excellent code generation\ngoogle/gemini-2.0-flash - Fast and cost-effective\nmeta-llama/llama-3.1-70b-instruct - Best open source","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Models","lvl3":""}},
@@ -5050,23 +5050,23 @@
5050
5050
  {"objectID":"52dff853050736b1f81c455943d3de772e3714e71eec3cddf64d8422907348d3","title":"Environment Variables","url":"/docs/getting-started/provider-setup#environment-variables-1","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Environment Variables","lvl3":""}},
5051
5051
  {"objectID":"ae87ef5d895f73d8dc3b67795f6abbf28923e8ccaee60461e60399adaa929d6c","title":"Optional: Custom endpoint","url":"/docs/getting-started/provider-setup#optional-custom-endpoint","content":"`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Optional: Custom endpoint","lvl3":""}},
5052
5052
  {"objectID":"91f008fe1e8011c5beda0e6b3bb974434b0d1f61dd78ecf991916fb8fd204b66","title":"Multilingual Support","url":"/docs/getting-started/provider-setup#multilingual-support","content":"Mistral models excel at multilingual tasks:\nEnglish, French, Spanish, German, Italian\nCode generation in multiple programming languages\nTranslation between supported languages","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Multilingual Support","lvl3":""}},
5053
- {"objectID":"940b249803ca3a90f130f8ead6b7eeff613d54baa6ca37c27392e04ae125a30b","title":"Anthropic Configuration {#anthropic}","url":"/docs/getting-started/provider-setup#anthropic-configuration-anthropic","content":"Direct access to Anthropic's Claude models. Supports both API key and OAuth (Claude subscription) authentication.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Anthropic Configuration {#anthropic}","lvl3":""}},
5053
+ {"objectID":"64870be97517ffeed82ed4cec5815318d78d33cb3323671bb454e2ec32efc66a","title":"Anthropic Configuration","url":"/docs/getting-started/provider-setup#anthropic","content":"Direct access to Anthropic's Claude models. Supports both API key and OAuth (Claude subscription) authentication.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Anthropic Configuration","lvl3":""}},
5054
5054
  {"objectID":"de4e6a755023761da4e804945407ed678d029570febb6df8dcc75c6333817594","title":"Basic Setup","url":"/docs/getting-started/provider-setup#basic-setup-6","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Basic Setup","lvl3":""}},
5055
5055
  {"objectID":"71b1993a9525bd56d863713131b9a04faff04d947492cad8387105de205a9db7","title":"Option 2: OAuth authentication (Claude Pro/Max subscribers)","url":"/docs/getting-started/provider-setup#option-2-oauth-authentication-claude-promax-subscribers","content":"neurolink auth login anthropic\n`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Option 2: OAuth authentication (Claude Pro/Max subscribers)","lvl3":""}},
5056
5056
  {"objectID":"0d0620f1d150c8c191687327893747d428934ae307034333dd0fb800b0762d96","title":"Supported Models","url":"/docs/getting-started/provider-setup#supported-models-4","content":"claude-opus-4-5-20251101 - Claude 4.5 Opus (most capable)\nclaude-sonnet-4-5-20250929 - Claude 4.5 Sonnet\nclaude-haiku-4-5-20251001 - Claude 4.5 Haiku (fastest)\nclaude-opus-4-1-20250805 - Claude 4.1 Opus\nclaude-opus-4-20250514 - Claude 4.0 Opus\nclaude-sonnet-4-20250514 - Claude 4.0 Sonnet\nclaude-3-7-sonnet-20250219 - Claude 3.7 Sonnet","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Models","lvl3":""}},
5057
5057
  {"objectID":"2c02c7b5e782a19f7808497e65d02e1e894cca77554a5864313748f84f3a3f42","title":"Timeout Configuration","url":"/docs/getting-started/provider-setup#timeout-configuration-8","content":"Default Timeout: 30 seconds\nSupported Formats: Milliseconds (30000), human-readable ('30s', '1m', '5m')\nEnvironment Variable: ANTHROPIC_TIMEOUT='45s' (optional)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Timeout Configuration","lvl3":""}},
5058
5058
  {"objectID":"a9d756792ea0f07cb2c74880c820b91c0eb7f73e8ad0dc8df015198175528e6d","title":"Getting Started with Anthropic","url":"/docs/getting-started/provider-setup#getting-started-with-anthropic","content":"API Key: Visit console.anthropic.com, navigate to API Keys, and export as ANTHROPIC_API_KEY\nOAuth (Subscription): Run neurolink auth login anthropic to authenticate with your Claude Pro/Max subscription","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Getting Started with Anthropic","lvl3":""}},
5059
5059
  {"objectID":"d74d9451c91478f2685eeae350b3e5fc679fd3a64cee5189285cb844e0ce6329","title":"Complete Guide","url":"/docs/getting-started/provider-setup#complete-guide-1","content":"For comprehensive Anthropic setup including OAuth configuration, subscription tiers, and advanced options, see the Detailed Anthropic Provider Guide and the Claude Subscription Guide.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Complete Guide","lvl3":""}},
5060
- {"objectID":"f9193c2261d7bc8cf53240456346ff19bbb64b8b05bd6dabaf0428148c91aaac","title":"Azure OpenAI Configuration {#azure}","url":"/docs/getting-started/provider-setup#azure-openai-configuration-azure","content":"Azure OpenAI provides enterprise-grade access to OpenAI models through Microsoft Azure.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Azure OpenAI Configuration {#azure}","lvl3":""}},
5060
+ {"objectID":"11b5ad3bb7d0f4e1822e7840a9d36b297b71057482d11df5be6fb61311c74fc7","title":"Azure OpenAI Configuration","url":"/docs/getting-started/provider-setup#azure","content":"Azure OpenAI provides enterprise-grade access to OpenAI models through Microsoft Azure.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Azure OpenAI Configuration","lvl3":""}},
5061
5061
  {"objectID":"be8fddf8865a99199fd4eda0b0e3768548d058732b03932fc66b8ec160fedb49","title":"Supported Models","url":"/docs/getting-started/provider-setup#supported-models-5","content":"Azure OpenAI supports deployment of:\ngpt-4o - Latest multimodal model\ngpt-4 - Advanced reasoning\ngpt-4-turbo - Optimized performance\ngpt-3.5-turbo - Cost-effective","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Models","lvl3":""}},
5062
5062
  {"objectID":"808cc92a9675c8aa9d62ff2f409a1d1b33866c4b1bd1768f2971b01bc827fc75","title":"Timeout Configuration","url":"/docs/getting-started/provider-setup#timeout-configuration-9","content":"Default Timeout: 30 seconds\nSupported Formats: Milliseconds (30000), human-readable ('30s', '1m', '5m')\nEnvironment Variable: AZURE_TIMEOUT='45s' (optional)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Timeout Configuration","lvl3":""}},
5063
5063
  {"objectID":"bb0a31c4c49df3d7c130c16d554a4adcbc4a908bc8fd5019d4a2b82ead6728bf","title":"Azure Setup Requirements","url":"/docs/getting-started/provider-setup#azure-setup-requirements","content":"Azure Subscription: Active Azure subscription\nAzure OpenAI Resource: Create Azure OpenAI resource in Azure Portal\nModel Deployment: Deploy a model to get deployment ID\nAPI Key: Get API key from resource's Keys and Endpoint section","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Azure Setup Requirements","lvl3":""}},
5064
5064
  {"objectID":"5bb77fc371474d662ed8c79f286ea6d68bf5ad8d79a5ba71819c55c3e6bad7ff","title":"Environment Variables Reference","url":"/docs/getting-started/provider-setup#environment-variables-reference-1","content":"| Variable | Required | Description |\n| ---------------------------- | -------- | ----------------------------- |\n| AZURE_OPENAI_API_KEY | ✅ | Azure OpenAI API key |\n| AZURE_OPENAI_ENDPOINT | ✅ | Resource endpoint URL |\n| AZURE_OPENAI_DEPLOYMENT_ID | ✅ | Model deployment name |\n| AZURE_OPENAI_API_VERSION | ❌ | API version (default: latest) |","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Environment Variables Reference","lvl3":""}},
5065
- {"objectID":"fa428e363cccf21f3a6f82408aea458dd26c8d4d58c51085df9ebc51f8a8faa4","title":"OpenAI Compatible Configuration {#openai-compatible}","url":"/docs/getting-started/provider-setup#openai-compatible-configuration-openai-compatible","content":"Connect to any OpenAI-compatible API endpoint (LocalAI, vLLM, Ollama with OpenAI compatibility, etc.)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"OpenAI Compatible Configuration {#openai-compatible}","lvl3":""}},
5065
+ {"objectID":"01d5dcfe853d5a170d7cdb819f23a5b2fa9fd8bfe37c80dd4c06eac230d054d2","title":"OpenAI Compatible Configuration","url":"/docs/getting-started/provider-setup#openai-compatible","content":"Connect to any OpenAI-compatible API endpoint (LocalAI, vLLM, Ollama with OpenAI compatibility, etc.)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"OpenAI Compatible Configuration","lvl3":""}},
5066
5066
  {"objectID":"eb0e08fd1f9a33d5668b837827273c2f775402a2e46a7d54ed9ef9c755a33934","title":"Compatible Servers","url":"/docs/getting-started/provider-setup#compatible-servers","content":"This works with any server implementing the OpenAI API:\nLocalAI - Local AI server\nvLLM - High-performance inference server\nOllama (with OLLAMA_OPENAI_COMPAT=1)\nText Generation WebUI\nCustom inference servers","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Compatible Servers","lvl3":""}},
5067
5067
  {"objectID":"42ddb7bb2c0fd183fff4f6227c9a5d0d32956eac996d329742f762e9bb2a670b","title":"Environment Variables","url":"/docs/getting-started/provider-setup#environment-variables-2","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Environment Variables","lvl3":""}},
5068
5068
  {"objectID":"477390896479a068efd167bb6281497ac2a9de1e3f60f8595ae93d591b8b6bd1","title":"Optional: Default model name","url":"/docs/getting-started/provider-setup#optional-default-model-name","content":"`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Optional: Default model name","lvl3":""}},
5069
- {"objectID":"bd26fec8d1ebf482b10a59963c6bdd543541c49500a53efcc8b7595d5e82a3ea","title":"DeepSeek Configuration {#deepseek}","url":"/docs/getting-started/provider-setup#deepseek-configuration-deepseek","content":"DeepSeek provides cost-effective access to its own frontier models: the general-purpose V3 chat model and the R1 reasoning model.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"DeepSeek Configuration {#deepseek}","lvl3":""}},
5069
+ {"objectID":"60d3822cd1528dbad3953414bbc285fa51b4dc06efd1764ea851cff6b1ba7bbe","title":"DeepSeek Configuration","url":"/docs/getting-started/provider-setup#deepseek","content":"DeepSeek provides cost-effective access to its own frontier models: the general-purpose V3 chat model and the R1 reasoning model.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"DeepSeek Configuration","lvl3":""}},
5070
5070
  {"objectID":"295cca2f4fdcf8ce1b30b799e2d7d6e705dda853eb1fab5dfc127dc70c2d1343","title":"Supported Models","url":"/docs/getting-started/provider-setup#supported-models-6","content":"deepseek-chat (default) - DeepSeek V3, high-quality general chat at low cost\ndeepseek-reasoner - DeepSeek R1, extended chain-of-thought reasoning (thinking mode)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Models","lvl3":""}},
5071
5071
  {"objectID":"18aafc423194613629cc9d2af2c83e0e81cd41ea68baba9ab6c0b86bd761e53a","title":"CLI Usage","url":"/docs/getting-started/provider-setup#cli-usage","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"CLI Usage","lvl3":""}},
5072
5072
  {"objectID":"79ab2bb80d498c99f58f0a68f5d84bd1a39cc38d961b6ae2dde757a133c6fc0e","title":"Use DeepSeek V3","url":"/docs/getting-started/provider-setup#use-deepseek-v3","content":"npx @juspay/neurolink generate \"Explain quantum computing\" --provider deepseek","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Use DeepSeek V3","lvl3":""}},
@@ -5074,7 +5074,7 @@
5074
5074
  {"objectID":"461ba3d6fbec85e63757c723e83707fd0870516bf0d9b8d9d2379ac2623fd6a4","title":"Getting Started with DeepSeek","url":"/docs/getting-started/provider-setup#getting-started-with-deepseek","content":"Create Account: Visit platform.deepseek.com\nGenerate Key: Navigate to API Keys and create a new key\nAdd Billing: Top up your account balance at platform.deepseek.com/usage\nSet Environment: Export DEEPSEEK_API_KEY","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Getting Started with DeepSeek","lvl3":""}},
5075
5075
  {"objectID":"8b46ce5c7c0844ad50246aef49044572f4c17bc2232b2acd76ea5a132a18695f","title":"Environment Variables Reference","url":"/docs/getting-started/provider-setup#environment-variables-reference-2","content":"| Variable | Required | Default | Description |\n| ------------------- | -------- | -------------------------- | ------------------------------------------------------- |\n| DEEPSEEK_API_KEY | ✅ | - | DeepSeek API key |\n| DEEPSEEK_MODEL | ❌ | deepseek-chat | Model: deepseek-chat (V3) or deepseek-reasoner (R1) |\n| DEEPSEEK_BASE_URL | ❌ | https://api.deepseek.com | Override for proxies or alternative endpoints |","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Environment Variables Reference","lvl3":""}},
5076
5076
  {"objectID":"cede4d703ccd04edb376d75db34bcb4ca2afcac75e2994c6714c79a1242ff047","title":"Provider ID and Aliases","url":"/docs/getting-started/provider-setup#provider-id-and-aliases","content":"Provider ID: deepseek\nAliases: ds","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider ID and Aliases","lvl3":""}},
5077
- {"objectID":"5d14fde929394b34084644b47a2e24c38774ae48e065dcdf8c65abb22e541ed0","title":"NVIDIA NIM Configuration {#nvidia-nim}","url":"/docs/getting-started/provider-setup#nvidia-nim-configuration-nvidia-nim","content":"NVIDIA NIM provides access to 400+ optimized models through NVIDIA's hosted cloud inference API, and also supports self-hosted NIM deployments.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"NVIDIA NIM Configuration {#nvidia-nim}","lvl3":""}},
5077
+ {"objectID":"21ee2df702ec7b676f898e665c300a089852122ecfdca3d74dfac4ccd992acc2","title":"NVIDIA NIM Configuration","url":"/docs/getting-started/provider-setup#nvidia-nim","content":"NVIDIA NIM provides access to 400+ optimized models through NVIDIA's hosted cloud inference API, and also supports self-hosted NIM deployments.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"NVIDIA NIM Configuration","lvl3":""}},
5078
5078
  {"objectID":"18321846566326d1547ba20c35f8190c7ae9c6fb3d6fb0fa9d807cdd7e32e1e0","title":"NIM-Specific Extras (Advanced)","url":"/docs/getting-started/provider-setup#nim-specific-extras-advanced","content":"These environment variables pass NIM-specific request body extensions. Leave them unset unless you have a specific need:","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"NIM-Specific Extras (Advanced)","lvl3":""}},
5079
5079
  {"objectID":"06fd92c3629ac0be9484c9214a7cfb3e40336689fdd7a7196b5adabb520e43ac","title":"Supported Models","url":"/docs/getting-started/provider-setup#supported-models-7","content":"meta/llama-3.3-70b-instruct (default) - Meta Llama 3.3 70B Instruct\nAny model from the NVIDIA NIM catalog","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Models","lvl3":""}},
5080
5080
  {"objectID":"b23f6c751e3a8b2b4bfece3ba129b68e25f6e00204058cadf954d3eb8a36b82a","title":"CLI Usage","url":"/docs/getting-started/provider-setup#cli-usage-1","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"CLI Usage","lvl3":""}},
@@ -5084,7 +5084,7 @@
5084
5084
  {"objectID":"01e42c60deafa5c50f53dd6572412b847c871735a4014652a0480cac5a5608ee","title":"Getting Started with NVIDIA NIM","url":"/docs/getting-started/provider-setup#getting-started-with-nvidia-nim","content":"Create Account: Visit build.nvidia.com\nOpen Settings: Navigate to Settings → API Keys\nGenerate Key: Create a new Bearer token API key\nBrowse Models: Explore the catalog at build.nvidia.com/models\nSet Environment: Export NVIDIA_NIM_API_KEY","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Getting Started with NVIDIA NIM","lvl3":""}},
5085
5085
  {"objectID":"2d33feba1ccdb840a4e9dbf01aaa90979c0c1335ef47a1a81b5d19e0e282dc46","title":"Environment Variables Reference","url":"/docs/getting-started/provider-setup#environment-variables-reference-3","content":"| Variable | Required | Default | Description |\n| ------------------------------- | -------- | ------------------------------------- | --------------------------------------- |\n| NVIDIA_NIM_API_KEY | ✅ | - | NVIDIA NIM API key (Bearer token) |\n| NVIDIA_NIM_MODEL | ❌ | meta/llama-3.3-70b-instruct | Default model |\n| NVIDIA_NIM_BASE_URL | ❌ | https://integrate.api.nvidia.com/v1 | Override for self-hosted NIM |\n| NVIDIA_NIM_TOP_K | ❌ | - | Top-K sampling parameter |\n| NVIDIA_NIM_MIN_P | ❌ | - | Min-P sampling parameter |\n| NVIDIA_NIM_REPETITION_PENALTY | ❌ | - | Repetition penalty |\n| NVIDIA_NIM_MIN_TOKENS | ❌ | - | Minimum tokens to generate |\n| NVIDIA_NIM_CHAT_TEMPLATE | ❌ | - | Override model chat template (advanced) |","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Environment Variables Reference","lvl3":""}},
5086
5086
  {"objectID":"109acc4b5c1417599beb44840e21a88619106838727981fb5e0feae447a57038","title":"Provider ID and Aliases","url":"/docs/getting-started/provider-setup#provider-id-and-aliases-1","content":"Provider ID: nvidia-nim\nAliases: nim, nvidia","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider ID and Aliases","lvl3":""}},
5087
- {"objectID":"40e91cc54c70347c4765f29707a13288adf8b4de9fd3d7ba24634554a0769544","title":"LM Studio Configuration {#lm-studio}","url":"/docs/getting-started/provider-setup#lm-studio-configuration-lm-studio","content":"LM Studio is a local AI provider — it runs models entirely on your machine with no data sent to any external service. No API key is required for standard (non-proxied) installations.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"LM Studio Configuration {#lm-studio}","lvl3":""}},
5087
+ {"objectID":"0de45c35b35d239ea38353c402bc07233b46803a89df62d4d0aecf8fd0a53e53","title":"LM Studio Configuration","url":"/docs/getting-started/provider-setup#lm-studio","content":"LM Studio is a local AI provider — it runs models entirely on your machine with no data sent to any external service. No API key is required for standard (non-proxied) installations.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"LM Studio Configuration","lvl3":""}},
5088
5088
  {"objectID":"51046d75613781b1d2770a64f2dbba80729a2e607c4aa529d60f2b53ca6676c4","title":"Prerequisites","url":"/docs/getting-started/provider-setup#prerequisites-2","content":"Install LM Studio from lmstudio.ai\nOpen LM Studio and download a model from the Discover tab\nGo to Local Server and click Start Server\n\nThe server starts at http://localhost:1234/v1 by default. NeuroLink auto-discovers the currently loaded model via /v1/models — you do not need to specify a model name.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Prerequisites","lvl3":""}},
5089
5089
  {"objectID":"e9945a8200dd89373de6c9daada6f9128be825309952a1b5762043d36fefbc28","title":"Optional Configuration","url":"/docs/getting-started/provider-setup#optional-configuration-10","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Optional Configuration","lvl3":""}},
5090
5090
  {"objectID":"1e5135dbf3f9e49e876517a076f78d19ffaa4e85e554c5db25446847cf2ca056","title":"export LM_STUDIO_API_KEY=\"your-key\" # Only needed behind an auth-proxying reverse-proxy","url":"/docs/getting-started/provider-setup#export-lm_studio_api_keyyour-key-only-needed-behind-an-auth-proxying-reverse-proxy","content":"`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"export LM_STUDIO_API_KEY=\"your-key\" # Only needed behind an auth-proxying reverse-proxy","lvl3":""}},
@@ -5095,7 +5095,7 @@
5095
5095
  {"objectID":"4fe98b89895d6546f3f3faf4cf0e2b9797b08cdee934ed8cc44248c3d9951826","title":"Timeout Configuration","url":"/docs/getting-started/provider-setup#timeout-configuration-10","content":"Default Timeout: 5 minutes (longer for local CPU/GPU inference)\nEnvironment Variable: LM_STUDIO_TIMEOUT='10m' (optional)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Timeout Configuration","lvl3":""}},
5096
5096
  {"objectID":"59be5f77427306e9bb01bcb11fa8a6334d88085d5bfd1eaf650a0056268b7775","title":"Environment Variables Reference","url":"/docs/getting-started/provider-setup#environment-variables-reference-4","content":"| Variable | Required | Default | Description |\n| -------------------- | -------- | -------------------------- | ----------------------------------------------------- |\n| LM_STUDIO_BASE_URL | ❌ | http://localhost:1234/v1 | LM Studio server URL |\n| LM_STUDIO_MODEL | ❌ | (auto-discovered) | Force a specific model ID; blank = use loaded model |\n| LM_STUDIO_API_KEY | ❌ | - | API key — only for reverse-proxy authenticated setups |","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Environment Variables Reference","lvl3":""}},
5097
5097
  {"objectID":"d15573aa77afa6b21add88c113c56d7b09d75fc0c1dca703c766c4f0f5f5dde4","title":"Provider ID and Aliases","url":"/docs/getting-started/provider-setup#provider-id-and-aliases-2","content":"Provider ID: lm-studio\nAliases: lmstudio, lms","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider ID and Aliases","lvl3":""}},
5098
- {"objectID":"7cc330202a53f3b6e4ad201029325828ec124f4a870fc6a735d596e0e6b40327","title":"llama.cpp Configuration {#llamacpp}","url":"/docs/getting-started/provider-setup#llamacpp-configuration-llamacpp","content":"llama.cpp's llama-server is a local AI provider — it runs GGUF models entirely on your machine. No API key is required for standard (non-proxied) installations.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"llama.cpp Configuration {#llamacpp}","lvl3":""}},
5098
+ {"objectID":"53ce0b69b2932ad67c2171d0cf946b287337d0e83e3f893b16358196a0bf83c6","title":"llama.cpp Configuration","url":"/docs/getting-started/provider-setup#llamacpp","content":"llama.cpp's llama-server is a local AI provider — it runs GGUF models entirely on your machine. No API key is required for standard (non-proxied) installations.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"llama.cpp Configuration","lvl3":""}},
5099
5099
  {"objectID":"582c4f8b01f08da1e7c3b30651b64bd299ff307127101b9958f53efb73717d99","title":"Prerequisites","url":"/docs/getting-started/provider-setup#prerequisites-3","content":"Build llama.cpp: follow the build instructions\nDownload a GGUF model file (e.g., from Hugging Face)\nStart the server:\n\n \n\nThe server starts at http://localhost:8080/v1 by default. NeuroLink auto-discovers the loaded model via /v1/models.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Prerequisites","lvl3":""}},
5100
5100
  {"objectID":"c7797958b8baeeade812fe23404e3916ddf21d3fac9149ceed79225fa18a83ab","title":"Optional Configuration","url":"/docs/getting-started/provider-setup#optional-configuration-11","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Optional Configuration","lvl3":""}},
5101
5101
  {"objectID":"5f2b4febdc3bb91e34d789fbffb81392ddea97dee8281ffcf0aef3fd509dc431","title":"export LLAMACPP_API_KEY=\"your-key\" # Only needed behind an auth-proxying reverse-proxy","url":"/docs/getting-started/provider-setup#export-llamacpp_api_keyyour-key-only-needed-behind-an-auth-proxying-reverse-proxy","content":"`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"export LLAMACPP_API_KEY=\"your-key\" # Only needed behind an auth-proxying reverse-proxy","lvl3":""}},
@@ -5106,7 +5106,7 @@
5106
5106
  {"objectID":"7017ddbb67b88d00c7aa5681d04d1cff61ce6f3b8949487df941bb66ef7232d8","title":"Timeout Configuration","url":"/docs/getting-started/provider-setup#timeout-configuration-11","content":"Default Timeout: 5 minutes (longer for local CPU/GPU inference)\nEnvironment Variable: LLAMACPP_TIMEOUT='10m' (optional)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Timeout Configuration","lvl3":""}},
5107
5107
  {"objectID":"025eca52d5c58359bd8779961ca5078ee05b93be74969a57b4606e234ee03ebd","title":"Environment Variables Reference","url":"/docs/getting-started/provider-setup#environment-variables-reference-5","content":"| Variable | Required | Default | Description |\n| ------------------- | -------- | -------------------------- | ----------------------------------------------------- |\n| LLAMACPP_BASE_URL | ❌ | http://localhost:8080/v1 | llama-server URL |\n| LLAMACPP_MODEL | ❌ | (auto-discovered) | Force a specific model ID; blank = use loaded model |\n| LLAMACPP_API_KEY | ❌ | - | API key — only for reverse-proxy authenticated setups |","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Environment Variables Reference","lvl3":""}},
5108
5108
  {"objectID":"55d5385b3a635f1cb6226bf87bc8f2e77195fc78dfb598936137d909d1d86a4e","title":"Provider ID and Aliases","url":"/docs/getting-started/provider-setup#provider-id-and-aliases-3","content":"Provider ID: llamacpp\nAliases: llama.cpp","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider ID and Aliases","lvl3":""}},
5109
- {"objectID":"98b43fcc7e3a471b8c67ecec018866ddd1687fe1151fce51ecf417d21eab6469","title":"Redis Configuration {#redis}","url":"/docs/getting-started/provider-setup#redis-configuration-redis","content":"Redis integration for distributed conversation memory and session state.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Redis Configuration {#redis}","lvl3":""}},
5109
+ {"objectID":"c53f7e2df00c372eca250a35a5b7e06b0ade4719fd45508227c0f6ceae9bb53c","title":"Redis Configuration","url":"/docs/getting-started/provider-setup#redis","content":"Redis integration for distributed conversation memory and session state.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Redis Configuration","lvl3":""}},
5110
5110
  {"objectID":"6dd86b8d9283dab3afee8e0f13d009bfff110d68c85d0f98a496622b56b66f84","title":"Advanced Configuration","url":"/docs/getting-started/provider-setup#advanced-configuration","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Advanced Configuration","lvl3":""}},
5111
5111
  {"objectID":"ffb36f2848a7cb13ac4280f1f070e7fa6015effb417018b35df5e5f6ea948d23","title":"Pool settings","url":"/docs/getting-started/provider-setup#pool-settings","content":"`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Pool settings","lvl3":""}},
5112
5112
  {"objectID":"4b3aa1c2093a0b27061547409c7879da636f032d7d07afcadd17af1738cebe7d","title":"Redis Cloud Setup","url":"/docs/getting-started/provider-setup#redis-cloud-setup","content":"For managed Redis (Redis Cloud, AWS ElastiCache, etc.):","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Redis Cloud Setup","lvl3":""}},
@@ -5121,13 +5121,13 @@
5121
5121
  {"objectID":"d1c9da88df4c439cfc04929b5ab9e582c9dcf0a26b68b5c56f180984ad17c1b8","title":"Method 1: File path","url":"/docs/getting-started/provider-setup#method-1-file-path","content":"GOOGLEAPPLICATIONCREDENTIALS=/path/to/your/service-account.json","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Method 1: File path","lvl3":""}},
5122
5122
  {"objectID":"71a4380ba3244eed6811384e4fc01c6c84e1ccd5a4076912108eed14b4d41e39","title":"Required for all Google Vertex AI methods","url":"/docs/getting-started/provider-setup#required-for-all-google-vertex-ai-methods","content":"GOOGLEVERTEXPROJECT=your-gcp-project-id\nGOOGLEVERTEXLOCATION=us-east5\nVERTEXMODELID=claude-sonnet-4@20250514","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Required for all Google Vertex AI methods","lvl3":""}},
5123
5123
  {"objectID":"0605d5b19ae18539742468b58c9a5b3adb826e156138d90914625429f94a5382","title":"Google AI Studio","url":"/docs/getting-started/provider-setup#google-ai-studio","content":"GOOGLEAIAPI_KEY=AIza-your-googleAiStudio-key\nGOOGLEAIMODEL=gemini-2.5-pro","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Google AI Studio","lvl3":""}},
5124
- {"objectID":"64870be97517ffeed82ed4cec5815318d78d33cb3323671bb454e2ec32efc66a","title":"Anthropic","url":"/docs/getting-started/provider-setup#anthropic","content":"ANTHROPICAPIKEY=sk-ant-api03-your-key","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Anthropic","lvl3":""}},
5124
+ {"objectID":"a1662cd01a2d9d18d76c9587afb87bb686991d0555a8931c85812c86cbf535ca","title":"Anthropic","url":"/docs/getting-started/provider-setup#anthropic","content":"ANTHROPICAPIKEY=sk-ant-api03-your-key","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Anthropic","lvl3":""}},
5125
5125
  {"objectID":"cf965d005c0f70cf1112484b661d0d43af8a2ad6626dfff0afc0fdd3177d475b","title":"Azure OpenAI","url":"/docs/getting-started/provider-setup#azure-openai","content":"AZUREOPENAIAPI_KEY=your-azure-key\nAZUREOPENAIENDPOINT=\"https://your-resource.openai.azure.com/\"\nAZUREOPENAIDEPLOYMENT_ID=your-deployment-name","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Azure OpenAI","lvl3":""}},
5126
5126
  {"objectID":"8e7a97f5e6a5eb26e133b0023b10c44d81735007a2a1d5021ede847145e28f82","title":"Hugging Face","url":"/docs/getting-started/provider-setup#hugging-face","content":"HUGGINGFACEAPIKEY=hfyourtoken_here\nHUGGINGFACE_MODEL=Qwen/Qwen2.5-72B-Instruct # Optional","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Hugging Face","lvl3":""}},
5127
5127
  {"objectID":"1717d21dcf0337d1ba982d378adee58a79d69c9750731e6221a5452d298b5549","title":"Ollama (Local AI)","url":"/docs/getting-started/provider-setup#ollama-local-ai","content":"OLLAMABASEURL=http://localhost:11434 # Optional\nOLLAMA_MODEL=llama2 # Optional","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Ollama (Local AI)","lvl3":""}},
5128
5128
  {"objectID":"b91820599904018f00cea4276cfc91286fa4221d50bafa6748d287abe7245e11","title":"Mistral AI","url":"/docs/getting-started/provider-setup#mistral-ai","content":"MISTRALAPIKEY=yourmistralapi_key\nMISTRAL_MODEL=mistral-small # Optional","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Mistral AI","lvl3":""}},
5129
- {"objectID":"60d3822cd1528dbad3953414bbc285fa51b4dc06efd1764ea851cff6b1ba7bbe","title":"DeepSeek","url":"/docs/getting-started/provider-setup#deepseek","content":"DEEPSEEKAPIKEY=sk-your-deepseek-key\nDEEPSEEK_MODEL=deepseek-chat # Optional (deepseek-chat or deepseek-reasoner)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"DeepSeek","lvl3":""}},
5130
- {"objectID":"21ee2df702ec7b676f898e665c300a089852122ecfdca3d74dfac4ccd992acc2","title":"NVIDIA NIM","url":"/docs/getting-started/provider-setup#nvidia-nim","content":"NVIDIANIMAPI_KEY=nvapi-your-nvidia-key\nNVIDIANIMMODEL=meta/llama-3.3-70b-instruct # Optional","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"NVIDIA NIM","lvl3":""}},
5129
+ {"objectID":"8be00cad8588b590119191752e127176aa98a744b8de8faafd81969ca7c1410e","title":"DeepSeek","url":"/docs/getting-started/provider-setup#deepseek","content":"DEEPSEEKAPIKEY=sk-your-deepseek-key\nDEEPSEEK_MODEL=deepseek-chat # Optional (deepseek-chat or deepseek-reasoner)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"DeepSeek","lvl3":""}},
5130
+ {"objectID":"1b93c8d5111da7fbcedd041fb9c787be67e75a7f90a1183963620402de094aa7","title":"NVIDIA NIM","url":"/docs/getting-started/provider-setup#nvidia-nim","content":"NVIDIANIMAPI_KEY=nvapi-your-nvidia-key\nNVIDIANIMMODEL=meta/llama-3.3-70b-instruct # Optional","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"NVIDIA NIM","lvl3":""}},
5131
5131
  {"objectID":"0e8d309905b49692497e0322acf934dac8edf5fc85c88ef872d3100981e0f3aa","title":"LM Studio (local — no API key required)","url":"/docs/getting-started/provider-setup#lm-studio-local-no-api-key-required","content":"LMSTUDIOBASE_URL=http://localhost:1234/v1 # Optional","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"LM Studio (local — no API key required)","lvl3":""}},
5132
5132
  {"objectID":"0713571a05df11ba9d256c649c6fcdaf80cb2fc629cd7934e4470f79907e1f52","title":"llama.cpp (local — no API key required)","url":"/docs/getting-started/provider-setup#llamacpp-local-no-api-key-required","content":"LLAMACPPBASEURL=http://localhost:8080/v1 # Optional","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"llama.cpp (local — no API key required)","lvl3":""}},
5133
5133
  {"objectID":"f5e38eb73f7c04b70da1b1780b86312bc0bccff94d52e439bcd19b34f62327e4","title":"Application Settings","url":"/docs/getting-started/provider-setup#application-settings","content":"DEFAULT_PROVIDER=auto\nNEUROLINK_DEBUG=false\n`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Application Settings","lvl3":""}},
@@ -5143,47 +5143,47 @@
5143
5143
  {"objectID":"9f398c9d7ddf85371418bb0440f2c8afd979ca97a5f814d73e98fe95f6f05506","title":"AWS Security","url":"/docs/getting-started/provider-setup#aws-security","content":"Use IAM roles instead of access keys when possible\nEnable CloudTrail for audit logging\nUse VPC endpoints for additional security\nImplement resource-based policies","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"AWS Security","lvl3":""}},
5144
5144
  {"objectID":"f9001bcd78b171ab7c31a8b4821385062a0225b9bec3a9acd1b2673dc5bab563","title":"Google Cloud Security","url":"/docs/getting-started/provider-setup#google-cloud-security","content":"Use service account keys with minimal permissions\nEnable audit logging\nUse VPC Service Controls for additional isolation\nRotate service account keys regularly","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Google Cloud Security","lvl3":""}},
5145
5145
  {"objectID":"e46209479dbd9974849c1c6000ca9ac24d39600dca7f6cb26a37bff2ed25c9dc","title":"General Security","url":"/docs/getting-started/provider-setup#general-security","content":"Use environment-specific configurations\nImplement rate limiting in your applications\nMonitor usage and costs\nUse HTTPS for all API communications","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"General Security","lvl3":""}},
5146
- {"objectID":"93ffc96be83ae6041fa4f7eee10c26670ea57c75d215b34f11ec66e6b1e2ad61","title":"OpenAI TTS Configuration {#openai-tts}","url":"/docs/getting-started/provider-setup#openai-tts-configuration-openai-tts","content":"OpenAI TTS provides text-to-speech synthesis using the same API key as the OpenAI LLM provider. No additional credentials are required.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"OpenAI TTS Configuration {#openai-tts}","lvl3":""}},
5146
+ {"objectID":"ba64f54cd580f8bdb6d886dd5358a8942ac204387fc5cecbb6c071e59ce69774","title":"OpenAI TTS Configuration","url":"/docs/getting-started/provider-setup#openai-tts","content":"OpenAI TTS provides text-to-speech synthesis using the same API key as the OpenAI LLM provider. No additional credentials are required.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"OpenAI TTS Configuration","lvl3":""}},
5147
5147
  {"objectID":"5d09f4daa4ef03bf543e60b368c957f62c273252de5ae1153dce38b60342ee99","title":"Basic Setup","url":"/docs/getting-started/provider-setup#basic-setup-12","content":"Note: OPENAI_API_KEY is shared with the OpenAI LLM provider. No separate key is needed.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Basic Setup","lvl3":""}},
5148
5148
  {"objectID":"6d7c01f775ce8adc3e103142ece7d1d3839bd7d0d4be21c9dd50c1a423ff591a","title":"Supported Models","url":"/docs/getting-started/provider-setup#supported-models-8","content":"tts-1 (default) - Optimized for speed, lower latency\ntts-1-hd - Optimized for quality, higher fidelity audio","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Models","lvl3":""}},
5149
5149
  {"objectID":"1cd99c38eb84edbbc7129ba6e071e6aab79dae028ba26de4144278a6479ea7a5","title":"Supported Voices","url":"/docs/getting-started/provider-setup#supported-voices","content":"alloy, echo, fable, onyx, nova, shimmer","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Voices","lvl3":""}},
5150
5150
  {"objectID":"45a7db1bf8e067fb75ac466d69de112fb9925e827f0ae41c890a210b033d2956","title":"Supported Output Formats","url":"/docs/getting-started/provider-setup#supported-output-formats","content":"mp3 (default), opus, wav, ogg","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Output Formats","lvl3":""}},
5151
5151
  {"objectID":"3ff65f75225a3a7150dd868650eec2d76ee5eca5fd2ddbf3f4f7faa68204007d","title":"Environment Variables Reference","url":"/docs/getting-started/provider-setup#environment-variables-reference-7","content":"| Variable | Required | Default | Description |\n| ---------------- | -------- | ------- | ----------------------------------- |\n| OPENAI_API_KEY | ✅ | - | Shared with the OpenAI LLM provider |","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Environment Variables Reference","lvl3":""}},
5152
5152
  {"objectID":"ffe5d215ea2da12ec8bee92b097e7f44882cccf1a63b6b5f970ae4d0e02651c1","title":"Provider ID and Aliases","url":"/docs/getting-started/provider-setup#provider-id-and-aliases-4","content":"Provider ID: openai-tts","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider ID and Aliases","lvl3":""}},
5153
- {"objectID":"e7c6a18554cf1c062157d76f14b5a6eacd335045da8a31da96c19ecdad66ed70","title":"ElevenLabs Configuration {#elevenlabs}","url":"/docs/getting-started/provider-setup#elevenlabs-configuration-elevenlabs","content":"ElevenLabs provides high-quality, multilingual text-to-speech synthesis with a wide selection of voices and voice cloning support.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"ElevenLabs Configuration {#elevenlabs}","lvl3":""}},
5153
+ {"objectID":"89aebd985f311e2d78c5da62f245e24d14336c6dbb4ba27c2376ecd71173f88f","title":"ElevenLabs Configuration","url":"/docs/getting-started/provider-setup#elevenlabs","content":"ElevenLabs provides high-quality, multilingual text-to-speech synthesis with a wide selection of voices and voice cloning support.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"ElevenLabs Configuration","lvl3":""}},
5154
5154
  {"objectID":"58a52fb6271659fa9271293d63af412cc421766bd94b20ad0701ca727593771a","title":"How to Get ElevenLabs API Key","url":"/docs/getting-started/provider-setup#how-to-get-elevenlabs-api-key","content":"Visit ElevenLabs\nSign up or log in to your account\nNavigate to Profile → API Key\nCopy the key","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"How to Get ElevenLabs API Key","lvl3":""}},
5155
5155
  {"objectID":"100085745fa6ce6f6901fda638b74e195b316ba7ba370e83eb487fb91815e06b","title":"Supported Models","url":"/docs/getting-started/provider-setup#supported-models-9","content":"eleven_multilingual_v2 (default) - Best quality, 29 languages\neleven_turbo_v2_5 - Low-latency streaming, 32 languages\neleven_flash_v2_5 - Fastest, suitable for real-time applications","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Models","lvl3":""}},
5156
5156
  {"objectID":"f9585ab9e91f56f571873ba431f15eaabfa2ece254bfda9bc9925d1d750031a3","title":"Notes","url":"/docs/getting-started/provider-setup#notes-2","content":"Multilingual support: ElevenLabs models support up to 32 languages with natural prosody\nVoice cloning: ElevenLabs supports custom voice IDs from your ElevenLabs account","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Notes","lvl3":""}},
5157
5157
  {"objectID":"b24b8c38b9db7c6765475e7427be8a927a9db80d33922b97d732f247c671af47","title":"Environment Variables Reference","url":"/docs/getting-started/provider-setup#environment-variables-reference-8","content":"| Variable | Required | Default | Description |\n| -------------------- | -------- | ------- | ------------------ |\n| ELEVENLABS_API_KEY | ✅ | - | ElevenLabs API key |","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Environment Variables Reference","lvl3":""}},
5158
5158
  {"objectID":"d4440416617d5532315ef3d83aa6a0e8798acf1399c859211044b18fcab02bec","title":"Provider ID and Aliases","url":"/docs/getting-started/provider-setup#provider-id-and-aliases-5","content":"Provider ID: elevenlabs","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider ID and Aliases","lvl3":""}},
5159
- {"objectID":"2e2c2453dd3ed8a25df7a7b8b3e9a852e206a3edd270610118334e0a79c81165","title":"Deepgram STT Configuration {#deepgram}","url":"/docs/getting-started/provider-setup#deepgram-stt-configuration-deepgram","content":"Deepgram provides fast, accurate speech-to-text transcription with support for real-time streaming and pre-recorded audio.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Deepgram STT Configuration {#deepgram}","lvl3":""}},
5159
+ {"objectID":"ed97aa37493621446d2b1bc26888ff1f4504c2696c847359b751048f4f604aab","title":"Deepgram STT Configuration","url":"/docs/getting-started/provider-setup#deepgram","content":"Deepgram provides fast, accurate speech-to-text transcription with support for real-time streaming and pre-recorded audio.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Deepgram STT Configuration","lvl3":""}},
5160
5160
  {"objectID":"6f7a5b018fe2cddcfbfd5c91303bb2f14d6d9de5785e9d96ada036b67f6eeef5","title":"How to Get Deepgram API Key","url":"/docs/getting-started/provider-setup#how-to-get-deepgram-api-key","content":"Visit Deepgram Console\nSign up or log in to your account\nNavigate to API Keys\nClick Create a New API Key\nCopy the key","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"How to Get Deepgram API Key","lvl3":""}},
5161
5161
  {"objectID":"b78f180b0988dba08e233357de262ce06d6188b9e8bff8bfc2f389cd28653c58","title":"Supported Models","url":"/docs/getting-started/provider-setup#supported-models-10","content":"nova-3 (default) - Latest, highest accuracy\nnova-2 - High accuracy, broad language support\nbase - Balanced accuracy and speed","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Supported Models","lvl3":""}},
5162
5162
  {"objectID":"3d19dfca4afab1db61cd7a9ddaf69fa8f450097b67126987177bd6a7c0fef952","title":"Notes","url":"/docs/getting-started/provider-setup#notes-3","content":"Streaming transcription: Deepgram supports real-time audio streaming for live transcription\nLanguage support: Deepgram nova models support 30+ languages","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Notes","lvl3":""}},
5163
5163
  {"objectID":"c7c7a7b22c57156443d1696ac8c21fddb7a5ab07edbe71c709c6b2d80e6565f8","title":"Environment Variables Reference","url":"/docs/getting-started/provider-setup#environment-variables-reference-9","content":"| Variable | Required | Default | Description |\n| ------------------ | -------- | ------- | ---------------- |\n| DEEPGRAM_API_KEY | ✅ | - | Deepgram API key |","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Environment Variables Reference","lvl3":""}},
5164
5164
  {"objectID":"76906bd90073188069f0e9b5674d0d8639989940af90cc4dbc774e91ed4d9912","title":"Provider ID and Aliases","url":"/docs/getting-started/provider-setup#provider-id-and-aliases-6","content":"Provider ID: deepgram (STT only — Deepgram's TTS product is not wired today)","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider ID and Aliases","lvl3":""}},
5165
- {"objectID":"345514db6b23fc7f9dc8eff9979b1f54f1821e2731fae8638bafcb5ef3711687","title":"Whisper Configuration {#whisper}","url":"/docs/getting-started/provider-setup#whisper-configuration-whisper","content":"Whisper is OpenAI's speech-to-text model — registered as the provider id whisper.\nIt accepts MP3, WAV, M4A, and FLAC inputs up to 25 MB.\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Whisper Configuration {#whisper}","lvl3":""}},
5165
+ {"objectID":"6fb6a9c8a9de6132fef6923dd0183e77bfbc7c04194f6eaad0370df74ed1598a","title":"Whisper Configuration","url":"/docs/getting-started/provider-setup#whisper","content":"Whisper is OpenAI's speech-to-text model — registered as the provider id whisper.\nIt accepts MP3, WAV, M4A, and FLAC inputs up to 25 MB.\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Whisper Configuration","lvl3":""}},
5166
5166
  {"objectID":"ecebc1cb89f29d6db66a5557014b699bcb68886eda265c89af786b87683e1e85","title":"Required environment variable","url":"/docs/getting-started/provider-setup#required-environment-variable","content":"OPENAIAPIKEY=sk-...\n`\n\nGet your API key from: OpenAI Platform > API Keys.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Required environment variable","lvl3":""}},
5167
5167
  {"objectID":"9354c243e2b6643e0375e0d375cd7fdb3e4b854cdfdaf6ade5396f9adbd032fd","title":"Provider ID","url":"/docs/getting-started/provider-setup#provider-id","content":"Provider ID: whisper","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider ID","lvl3":""}},
5168
- {"objectID":"f4b5a76bee6ce376740b01affb32df36105f5ad966728348aef579caae477b85","title":"Azure Speech Configuration {#azure-speech}","url":"/docs/getting-started/provider-setup#azure-speech-configuration-azure-speech","content":"Azure Cognitive Services Speech provides both TTS (azure-tts) and STT (azure-stt).\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Azure Speech Configuration {#azure-speech}","lvl3":""}},
5168
+ {"objectID":"aac45923c6fcd121d9546b13807e60f18b5cf644f564a41f53054033a6e92b9b","title":"Azure Speech Configuration","url":"/docs/getting-started/provider-setup#azure-speech","content":"Azure Cognitive Services Speech provides both TTS (azure-tts) and STT (azure-stt).\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Azure Speech Configuration","lvl3":""}},
5169
5169
  {"objectID":"bacb9a206a3021bb445e9e45a5eda9b5340c26833afa47b7d3c7ebd49415e329","title":"Required environment variables","url":"/docs/getting-started/provider-setup#required-environment-variables","content":"AZURESPEECHKEY=your-speech-key\nAZURESPEECHREGION=eastus\n`\n\nGet credentials from: Azure Portal > Cognitive Services > Speech > Keys and Endpoint.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Required environment variables","lvl3":""}},
5170
5170
  {"objectID":"6d498629ed2b0daa9a4e84a3f5eba013bc1b9ece221c13ea91ec2c52ef3fd89e","title":"STT Usage","url":"/docs/getting-started/provider-setup#stt-usage","content":"MP3 not supported — Azure's short-audio REST endpoint only decodes WAV\nPCM and Ogg/Opus. Passing format: \"mp3\" to azure-stt throws\nSTT_INVALID_AUDIO_FORMAT early. Convert with\nffmpeg -i in.mp3 -ar 16000 -ac 1 out.wav first.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"STT Usage","lvl3":""}},
5171
5171
  {"objectID":"55250cbdfacb90dc1d66e47b8cd1e4e062a090cc97a6e7bcb24acb8b8244ad9f","title":"Provider IDs","url":"/docs/getting-started/provider-setup#provider-ids","content":"TTS: azure-tts\nSTT: azure-stt","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider IDs","lvl3":""}},
5172
- {"objectID":"1ae9180f0f6d2638190d7349a1fb0b18b71866d1e441a29ed169e0e6508d7250","title":"Fish Audio TTS Configuration {#fish-audio}","url":"/docs/getting-started/provider-setup#fish-audio-tts-configuration-fish-audio","content":"Low-cost TTS provider focused on voice cloning. Wrapped as a TTSHandler so it\nslots into the same generate({ tts: { provider: \"fish-audio\" } }) flow as\nOpenAI / ElevenLabs / Azure / Google AI TTS.\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Fish Audio TTS Configuration {#fish-audio}","lvl3":""}},
5172
+ {"objectID":"294715a0552861f000e450d5d69d9762e80f0deca32f93bdf6a3b39a54d4df0e","title":"Fish Audio TTS Configuration","url":"/docs/getting-started/provider-setup#fish-audio","content":"Low-cost TTS provider focused on voice cloning. Wrapped as a TTSHandler so it\nslots into the same generate({ tts: { provider: \"fish-audio\" } }) flow as\nOpenAI / ElevenLabs / Azure / Google AI TTS.\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Fish Audio TTS Configuration","lvl3":""}},
5173
5173
  {"objectID":"e80371806e5bfb720ffd850f4ffc6e83d033bf08f85816d5a88eee8052dfdfd0","title":"Required","url":"/docs/getting-started/provider-setup#required","content":"FISHAUDIOAPI_KEY=your-fish-audio-api-key","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Required","lvl3":""}},
5174
5174
  {"objectID":"01e82827c25c832ef7662bf57bee8b5c4983c952497a75f83bca5321a64aee2f","title":"FISH_AUDIO_BASE_URL=https://api.fish.audio","url":"/docs/getting-started/provider-setup#fish_audio_base_urlhttpsapifishaudio","content":"`\n\nGet an API key from fish.audio → dashboard.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"FISH_AUDIO_BASE_URL=https://api.fish.audio","lvl3":""}},
5175
5175
  {"objectID":"8166ba766d0e9951796b8b9aab77383d2f0a9da78eb4f06fa32b6a5978600536","title":"Usage","url":"/docs/getting-started/provider-setup#usage-1","content":"Provider ID: fish-audio\nDefault model: s1 (override via tts.model: speech-1.5, speech-1.6, s1)\nMax text length: 5000 characters\nOutput formats: mp3 (default, 44.1 kHz), wav (44.1 kHz), pcm16 (raw, 44.1 kHz)\nLanguages: 14 (English, Mandarin, Cantonese, Japanese, Korean, French, German, Spanish, Italian, Portuguese, Russian, Arabic, Hindi, Indonesian)\nVoice cloning: 15 s of reference audio → custom reference_id\n\nFull guide: Fish Audio TTS Provider.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Usage","lvl3":""}},
5176
- {"objectID":"f00234b6f82dab4011b335736c67e2eb1d8ee5abb99214e293c806e3faf41dcc","title":"Cartesia TTS Configuration {#cartesia}","url":"/docs/getting-started/provider-setup#cartesia-tts-configuration-cartesia","content":"Low-latency TTS provider running Cartesia's Sonic models. The synchronous\n/tts/bytes endpoint is wrapped as a TTSHandler; the realtime WebSocket flow\nis exposed separately as CartesiaStream for the voice server.\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Cartesia TTS Configuration {#cartesia}","lvl3":""}},
5176
+ {"objectID":"0bdad5bc6b05c9d92138214cee279e49315c2311e9fff41db914fb6b205b796f","title":"Cartesia TTS Configuration","url":"/docs/getting-started/provider-setup#cartesia","content":"Low-latency TTS provider running Cartesia's Sonic models. The synchronous\n/tts/bytes endpoint is wrapped as a TTSHandler; the realtime WebSocket flow\nis exposed separately as CartesiaStream for the voice server.\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Cartesia TTS Configuration","lvl3":""}},
5177
5177
  {"objectID":"b61647c23405ab4aa25156852b4f57ee2cb867d73e5898efcb5a4e518b066062","title":"Required","url":"/docs/getting-started/provider-setup#required-1","content":"CARTESIAAPIKEY=skcar...","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Required","lvl3":""}},
5178
5178
  {"objectID":"4efaa916b6bc11d3511200b5104f217302b0858ae5dbbe7e361d12db3c5d5edf","title":"CARTESIA_BASE_URL=https://api.cartesia.ai","url":"/docs/getting-started/provider-setup#cartesia_base_urlhttpsapicartesiaai","content":"`\n\nGet an API key from play.cartesia.ai/keys.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"CARTESIA_BASE_URL=https://api.cartesia.ai","lvl3":""}},
5179
5179
  {"objectID":"4159b052313e06e6cc4d1edcd94e6b942ce4e37f66933dd54561429399c9fa73","title":"Usage","url":"/docs/getting-started/provider-setup#usage-2","content":"Provider ID: cartesia\nDefault model: sonic-2 (also sonic)\nDefault voice: 694f9389-aac1-45b6-b726-9d9369183238 (\"Bright Female\", English)\nMax text length: 5000 characters\nOutput formats: mp3 (default, 44.1 kHz), wav (PCM s16le @ 44.1 kHz), pcm16 (raw, 24 kHz)\nStreaming: synchronous via this handler; WebSocket via CartesiaStream adapter\n\nFull guide: Cartesia TTS Provider.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Usage","lvl3":""}},
5180
- {"objectID":"9a0aa072d22ab977cb980253997f44813cca55ffeb338dfb2fb1b05f3864e08a","title":"Google Speech Configuration {#google-speech}","url":"/docs/getting-started/provider-setup#google-speech-configuration-google-speech","content":"Covers both Google Cloud TTS (google-tts / via google-ai) and Google Cloud\nSpeech-to-Text (google-stt). Both share the same service-account credentials.\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Google Speech Configuration {#google-speech}","lvl3":""}},
5180
+ {"objectID":"5e2b9d2431513e581e1d4b6eb8ac28616244d19938876d778a83fa67d2bce35c","title":"Google Speech Configuration","url":"/docs/getting-started/provider-setup#google-speech","content":"Covers both Google Cloud TTS (google-tts / via google-ai) and Google Cloud\nSpeech-to-Text (google-stt). Both share the same service-account credentials.\n\n`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Google Speech Configuration","lvl3":""}},
5181
5181
  {"objectID":"dbcc9f86ecc3a983362842c2d35a3c346ad0de236904ccb132382ea295198072","title":"Required environment variable","url":"/docs/getting-started/provider-setup#required-environment-variable-1","content":"GOOGLEAPPLICATIONCREDENTIALS=/path/to/service-account.json","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Required environment variable","lvl3":""}},
5182
5182
  {"objectID":"bde2796050f4d740a96f8266206f541aae2c58920c0d08e763dad57c5f4faff3","title":"OR (for TTS only) an API key","url":"/docs/getting-started/provider-setup#or-for-tts-only-an-api-key","content":"GOOGLEAPIKEY=AIza...\n\n\n> **Speech-to-Text API must be enabled** in your Google Cloud project for\n> google-stt` to work. Enable it at\nconsole.cloud.google.com/apis/library/speech.googleapis.com.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"OR (for TTS only) an API key","lvl3":""}},
5183
5183
  {"objectID":"55ef1ce61be2f31641d0c32b539abe63bb6b64fec206fe015f84cac18209ab98","title":"Provider IDs","url":"/docs/getting-started/provider-setup#provider-ids-1","content":"TTS: google-ai (or google-tts alias)\nSTT: google-stt","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider IDs","lvl3":""}},
5184
- {"objectID":"c89a1cee10f11e474988e04d45d539507aff3e472c9aac00203f0e5c0b394a6b","title":"OpenAI Realtime Configuration {#openai-realtime}","url":"/docs/getting-started/provider-setup#openai-realtime-configuration-openai-realtime","content":"Real-time voice via the OpenAI Realtime WebSocket API. Provider id\nopenai-realtime is registered for future use; the typical pattern is to\nlaunch the integrated voice server (neurolink serve voice) which wires\nthis through Soniox/Cartesia.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"OpenAI Realtime Configuration {#openai-realtime}","lvl3":""}},
5184
+ {"objectID":"38f6104606a18e88e8d3094511da9a132052ef7732951df806f38eb1300ec673","title":"OpenAI Realtime Configuration","url":"/docs/getting-started/provider-setup#openai-realtime","content":"Real-time voice via the OpenAI Realtime WebSocket API. Provider id\nopenai-realtime is registered for future use; the typical pattern is to\nlaunch the integrated voice server (neurolink serve voice) which wires\nthis through Soniox/Cartesia.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"OpenAI Realtime Configuration","lvl3":""}},
5185
5185
  {"objectID":"19ee46f34134e22513e959e9de371b8eb31972e8a96dc3e9427c61d8b5214033","title":"Provider ID","url":"/docs/getting-started/provider-setup#provider-id-1","content":"Provider ID: openai-realtime\nAudio chunk format: pcm16 — raw 16-bit PCM at 24 kHz, NOT\n WAV-headered. Do not pass these chunks to a WAV duration parser.","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider ID","lvl3":""}},
5186
- {"objectID":"141898b1b87a4fed8b878c3db86b79545bc2699f2a8a00957becdac82a41b6c0","title":"Gemini Live Configuration {#gemini-live}","url":"/docs/getting-started/provider-setup#gemini-live-configuration-gemini-live","content":"Real-time voice via Google's Gemini Live WebSocket API. Provider id\ngemini-live is registered for future use.\n\n`bash\nGOOGLEAPIKEY=AIza...","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Gemini Live Configuration {#gemini-live}","lvl3":""}},
5186
+ {"objectID":"eb01c79629b08a84406cf42283de8518cc103c24d7f4b34205dc584e19be166a","title":"Gemini Live Configuration","url":"/docs/getting-started/provider-setup#gemini-live","content":"Real-time voice via Google's Gemini Live WebSocket API. Provider id\ngemini-live is registered for future use.\n\n`bash\nGOOGLEAPIKEY=AIza...","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Gemini Live Configuration","lvl3":""}},
5187
5187
  {"objectID":"70b84d0be03827e001b6d05670d5f52b63e1fb6dc11f12c9696bfadd99a4266a","title":"OR","url":"/docs/getting-started/provider-setup#or-1","content":"GOOGLEAPPLICATIONCREDENTIALS=/path/to/service-account.json\n`","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"OR","lvl3":""}},
5188
5188
  {"objectID":"692fcd0ce7dabb7b8c99a22dc148cfab07a092835564deb63ae44194dc8d6ecb","title":"Provider ID","url":"/docs/getting-started/provider-setup#provider-id-2","content":"Provider ID: gemini-live","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"Provider ID","lvl3":""}},
5189
5189
  {"objectID":"7888b58098daa64d6c18ef501469033f7d2f48f5377e89df007e3f0aa57e237f","title":"stream() + TTS Mode 2 (synthesise the streamed reply)","url":"/docs/getting-started/provider-setup#stream-tts-mode-2-synthesise-the-streamed-reply","content":"Two ergonomic options — both deliver byte-identical audio:\n\nWhen tts.useAiResponse is false (Mode 1) or TTS is not enabled,\nr.audio resolves to undefined rather than hanging.\n\n← Back to Main README | Next: API Reference →","hierarchy":{"lvl0":"Getting Started","lvl1":"⚙️ Provider Configuration Guide","lvl2":"stream() + TTS Mode 2 (synthesise the streamed reply)","lvl3":""}},
@@ -5194,7 +5194,7 @@
5194
5194
  {"objectID":"e17d270317bfdd4cc49591a6baecedcedff0aa5d9f731d0ecfb3721634679105","title":"3. Use it","url":"/docs/getting-started/providers/above-dev#3-use-it","content":"`bash","hierarchy":{"lvl0":"Getting Started","lvl1":"above.dev Provider Guide","lvl2":"3. Use it","lvl3":""}},
5195
5195
  {"objectID":"d6b1722a1fcbf610d4440316e2514e2baf09e7983afa3933c9bfc91edc5aa2bc","title":"CLI","url":"/docs/getting-started/providers/above-dev#cli","content":"npx @juspay/neurolink generate \"Hello\" --provider above-dev\ntypescript\nawait neurolink.generate({\n input: { text: \"Hello\" },\n provider: \"above-dev\",\n credentials: { \"above-dev\": { apiKey: process.env.ABOVEDEVAPI_KEY } },\n});\n`","hierarchy":{"lvl0":"Getting Started","lvl1":"above.dev Provider Guide","lvl2":"CLI","lvl3":""}},
5196
5196
  {"objectID":"9f9bd5d3dbcf322f8e478f11de219686545593e90ff8b049ee03567751be419e","title":"Models","url":"/docs/getting-started/providers/above-dev#models","content":"| Model | Context | Vision | $/M in · out | Notes |\n| -------------------------- | ------- | ------ | ---------------------- | ------------------------------------------------------------------------------- |\n| deepseek-v4.1-flash ⭐ | 1M | yes\\* | time-of-day (see note) | Default — the id above.dev itself routes to when no model is named. Tier T1. |\n| deepseek-v4-pro | 1M | no | time-of-day (see note) | Tier T2 (\"agentic — multi-step, tool-capable\" per the vendor's own tier table). |\n| glm-5.2 | 1.05M | no | $1.54 / $4.84 | Zhipu GLM 5.2. Tier T2. |\n| glm-5.3-flash | 1.05M | yes\\* | $0.165 / $0.55 | Zhipu GLM 5.3 Flash. Tier T1. |\n| glm-5.2-fast | 1.05M | no | $2.31 / $7.26 | Zhipu GLM 5.2 Fast. Tier T3 (\"highest capability in the catalog\"). |\n| qwen3.8-max | 1M | yes\\* | $2.20 / $6.60 | Alibaba Qwen 3.8 Max. Tier T3. |\n| mimo-v2.6-pro | 1M | no | $0.5077 / $1.0154 | MiMo V2.6 Pro. Tier T2. |\n| mimo-v2.6-flash | 1M | no | $0.1692 / $0.3385 | MiMo V2.6 Flash. Tier T1. |\n| mimo-v2.6-pro-ultraspeed | 1M | no | $5.0769 / $10.1538 | MiMo V2.6 Pro UltraSpeed. Tier T3. |\n\n\\ Vision is supports_vision: true as *self-reported by above.dev's own\nGET /v1/models response (unauthenticated, retrieved 2026-09-28). No image\nwas actually sent to any model — this is vendor-stated metadata, not a\nlive-probed result, so models.visionModel is deliberately left unset in the","hierarchy":{"lvl0":"Getting Started","lvl1":"above.dev Provider Guide","lvl2":"Models","lvl3":""}},
5197
- {"objectID":"6405e1dde4448290fadbbd57c9562896bc521743e12796f118b70b403a304bf9","title":"Tools & structured output — a documented caveat {#tools-and-structured-output}","url":"/docs/getting-started/providers/above-dev#tools-structured-output-a-documented-caveat-tools-and-structured-output","content":"above.dev's own API reference table describes the /v1/messages request\nparameters differently depending on the field:\ntemperature — \"Passed through to the model.\"\ntool_choice — \"Tool choice control. Passed through to the model.\"\ntools — \"Tool definitions. Presence influences routing toward\n tool-capable models.\"\nresponse_format — \"Structured output format. Presence scores toward\n structured-output models.\"\n\nThe docs never state that tools or response_format are forwarded to, or\nhonoured by, whichever model ends up serving the request — only that sending\nthem nudges above.dev's routing. No example response containing tool_calls,\na finish_reason value, or a reasoning/reasoning_content field appears\nanywhere in the docs. GET /v1/models does self-report\nsupports_tool_calls: true and supports_structured_output: true for every\nmodel in the roster, but that is unauthenticated, vendor-supplied metadata,\nnot a probed result.\n\nGiven that ambiguity and that no live request (which would require a paid\nkey) was made:\ncapabilities.tools is set to \"model-dependent\" rather than true.\ncapabilities.structuredOutput and capabilities.structuredOutputWithTools\n are both false.\ncapabilities.thinking is false — GET /v1/models reports\n supports_reasoning: true for every model, but the human-readable docs\n never document a reasoning/thinking request or response field, so this\n is not treated as a confirmed NeuroLink-facing capability.\n\nA future pass with a real key should re-probe all of this the way\nfriendli.json/novita.json were probed (see docs/provider-integration/tiers/tier-2-catalog-entry.md#live-verification)\nand tighten these flags with evidence.liveMatrix filled in.","hierarchy":{"lvl0":"Getting Started","lvl1":"above.dev Provider Guide","lvl2":"Tools & structured output — a documented caveat {#tools-and-structured-output}","lvl3":""}},
5197
+ {"objectID":"fa10d9b6d2cbc626c970646b62fd83bb6eb40f33777dd00ee68fd4705540d3c5","title":"Tools & structured output — a documented caveat","url":"/docs/getting-started/providers/above-dev#tools-and-structured-output","content":"above.dev's own API reference table describes the /v1/messages request\nparameters differently depending on the field:\ntemperature — \"Passed through to the model.\"\ntool_choice — \"Tool choice control. Passed through to the model.\"\ntools — \"Tool definitions. Presence influences routing toward\n tool-capable models.\"\nresponse_format — \"Structured output format. Presence scores toward\n structured-output models.\"\n\nThe docs never state that tools or response_format are forwarded to, or\nhonoured by, whichever model ends up serving the request — only that sending\nthem nudges above.dev's routing. No example response containing tool_calls,\na finish_reason value, or a reasoning/reasoning_content field appears\nanywhere in the docs. GET /v1/models does self-report\nsupports_tool_calls: true and supports_structured_output: true for every\nmodel in the roster, but that is unauthenticated, vendor-supplied metadata,\nnot a probed result.\n\nGiven that ambiguity and that no live request (which would require a paid\nkey) was made:\ncapabilities.tools is set to \"model-dependent\" rather than true.\ncapabilities.structuredOutput and capabilities.structuredOutputWithTools\n are both false.\ncapabilities.thinking is false — GET /v1/models reports\n supports_reasoning: true for every model, but the human-readable docs\n never document a reasoning/thinking request or response field, so this\n is not treated as a confirmed NeuroLink-facing capability.\n\nA future pass with a real key should re-probe all of this the way\nfriendli.json/novita.json were probed (see docs/provider-integration/tiers/tier-2-catalog-entry.md#live-verification)\nand tighten these flags with evidence.liveMatrix filled in.","hierarchy":{"lvl0":"Getting Started","lvl1":"above.dev Provider Guide","lvl2":"Tools & structured output — a documented caveat","lvl3":""}},
5198
5198
  {"objectID":"921ba7d6a43c203510a37ebd9cc837a34360fc6595cebc700debe6ef747be8ee","title":"Verification status","url":"/docs/getting-started/providers/above-dev#verification-status","content":"Tier-2 onboarding requires evidence before a provider is accepted, and\npnpm run verify:provider-onboarding gates it in CI. This is what the\ncatalog currently records for above.dev — docs- and roster-verified only,\nnot yet live-verified:\n\n| Probe | Result |\n| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| Roster | unauthenticated GET https://api.above.dev/v1/models — HTTP 200, 9 models, 2026-09-28. No key used. |\n| Docs cross-check | https://above.dev/docs fetched and re-read 2026-09-28 for auth header shape, endpoints, pricing, limits and error codes. |\n| Auth rejection probe | Not performed — would require sending a request with a credential header, which is out of scope for a credential-free onboarding. |\n| Live capability sweep | Not performed — evidence.liveMatrix is null. No generate()/stream() call has been made against above-dev yet. |\n\nUntil a live matrix run fills in evidence.liveMatrix, treat tools,\nstructuredOutput, structuredOutputWithTools and thinking as unproven —\nthe catalog entry already reflects that by declining to assert them.","hierarchy":{"lvl0":"Getting Started","lvl1":"above.dev Provider Guide","lvl2":"Verification status","lvl3":""}},
5199
5199
  {"objectID":"72ecfa90e15b96485c0280ca134e1ccfa26e41851f2e632db44ddcaae149211c","title":"Troubleshooting","url":"/docs/getting-started/providers/above-dev#troubleshooting","content":"| Symptom | Cause | Fix |\n| -------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |\n| Invalid or missing above.dev API key | ABOVE_DEV_API_KEY unset, wrong, or inactive (401) | Check the key and get/rotate one at https://above.dev/pricing / https://above.dev/dashboard |\n| Account balance insufficient (402) | No purchased credit remaining | Top up at https://above.dev/pricing |\n| Model not enabled for key (403) | The model is plan-restricted or in private beta for this key | Pick another catalog model, or contact above.dev to enable it |\n| Rate limited (429) | More than 300 requests/minute on the account | Retry after the documented Retry-After header |\n| Upstream timeout (504) | provider_timeout — the routed model did not respond in time | Retry the request |","hierarchy":{"lvl0":"Getting Started","lvl1":"above.dev Provider Guide","lvl2":"Troubleshooting","lvl3":""}},
5200
5200
  {"objectID":"067a3642c950dd7d23c8df2f3ef9371ac1ded9e230a1aed516805bfca28ed5ac","title":"See also","url":"/docs/getting-started/providers/above-dev#see-also","content":"Provider setup overview\nAll providers\nTier-2 onboarding — how this provider's JSON becomes a working integration\nProvider feature compatibility","hierarchy":{"lvl0":"Getting Started","lvl1":"above.dev Provider Guide","lvl2":"See also","lvl3":""}},
@@ -6063,7 +6063,7 @@
6063
6063
  {"objectID":"6ad36ba3488491bb913c7a77b86a278cc86509da88a054975bcded71f5c02130","title":"[OpenRouter](/docs/getting-started/providers/openrouter)","url":"/docs/getting-started/providers#openrouterdocsgetting-startedprovidersopenrouter","content":"300+ models from 60+ providers\n🌐 Single API across many AI providers (Anthropic, OpenAI, Google, Meta, etc.)\n⚡ Automatic failover and routing\n💰 Competitive pricing with cost optimization\n🎯 Zero lock-in - switch models instantly\n📊 Usage tracking dashboard\n🆓 Free models available\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[OpenRouter](/docs/getting-started/providers/openrouter)","lvl3":""}},
6064
6064
  {"objectID":"733a2fa8ea4c547cdcdf502f89f003a2208c0e5828e36e7faaaa94e0903d3d49","title":"[OpenAI Compatible](/docs/getting-started/providers/openai-compatible)","url":"/docs/getting-started/providers#openai-compatibledocsgetting-startedprovidersopenai-compatible","content":"OpenRouter, vLLM, LocalAI, and more\n🌐 100+ models through OpenRouter\n💻 Local deployment with vLLM\n🔓 Self-hosted with LocalAI\n🔄 Drop-in OpenAI replacement\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[OpenAI Compatible](/docs/getting-started/providers/openai-compatible)","lvl3":""}},
6065
6065
  {"objectID":"fc415454bfde58f3634df544ef2adb88836c75fb1344b7042af7a9d6fdfa63d4","title":"[LiteLLM](/docs/getting-started/providers/litellm)","url":"/docs/getting-started/providers#litellmdocsgetting-startedproviderslitellm","content":"100+ providers through proxy\n🔄 Unified API for 100+ providers\n📊 Load balancing and fallbacks\n💰 Cost tracking\n🎯 Model routing\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[LiteLLM](/docs/getting-started/providers/litellm)","lvl3":""}},
6066
- {"objectID":"faae7281e5a366b4892035d92012602a9e7aaa15cc9d96556b20493e25562498","title":"🧠 Decision-Only Providers {#decision-only-providers}","url":"/docs/getting-started/providers#-decision-only-providers-decision-only-providers","content":"The providers that serve decide rather than generate/stream:\nTypeSafe, Laya and XOR. Each returns typed\nboolean/choice/score answers and emits no text, so none appears in\ngeneration fallback chains or the health sweep.","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"🧠 Decision-Only Providers {#decision-only-providers}","lvl3":""}},
6066
+ {"objectID":"6337b6964b5ebadd9610f93633594d912ee39f49c2ef5e1683214dce45a1aee3","title":"🧠 Decision-Only Providers","url":"/docs/getting-started/providers#decision-only-providers","content":"The providers that serve decide rather than generate/stream:\nTypeSafe, Laya and XOR. Each returns typed\nboolean/choice/score answers and emits no text, so none appears in\ngeneration fallback chains or the health sweep.","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"🧠 Decision-Only Providers","lvl3":""}},
6067
6067
  {"objectID":"50860d1f7a27dbe3ad7452ad7079ea437658db372b97081d0a509429369cacc6","title":"[TypeSafe (Jev)](/docs/getting-started/providers/typesafe)","url":"/docs/getting-started/providers#typesafe-jevdocsgetting-startedproviderstypesafe","content":"Typed, calibrated judgments instead of text\n🎯 boolean / choice / score answers, each with a calibrated confidence\n⚡ Latency flat in question count — 1 question ~393 ms, 400 questions ~465 ms\n💰 ~$0.00002 per decision (~$0.042/M input, output billed at zero)\n🔌 Two transports: TypeSafe direct, or the Vercel AI Gateway\n🛡️ Fails open — with no key configured, every consumer behaves exactly as before\n🔑 API key from console.typesafe.ai/keys\n🔄 Aliases: jev, typesafe-ai\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[TypeSafe (Jev)](/docs/getting-started/providers/typesafe)","lvl3":""}},
6068
6068
  {"objectID":"43b838d60f2794ce46361196d6fc8a708b3a301398dd55f2c8015d567aa21c2c","title":"[Laya](/docs/getting-started/providers/laya)","url":"/docs/getting-started/providers#layadocsgetting-startedproviderslaya","content":"Open-weights decision provider — the same typed boolean/choice/score answers as Jev, from Convai Innovations' Apache-2.0 checkpoints, at a Laya server or LiteLLM proxy route you configure\n🧭 Serves decide only; built-in features use it when its key and base URL are set and neither TYPESAFE_API_KEY nor AI_GATEWAY_API_KEY is\n📏 Refuses more than ~768 tokens of state (320 on english) before any network call, since its encoders read only 1,024 (512)\n🔌 No built-in endpoint: LAYA_BASE_URL (or credentials.laya.baseURL) names a Laya server or a LiteLLM pass-through route to one\n🔑 LAYA_API_KEY is the key that endpoint accepts; on LiteLLM, the route must be in the key's Allowed Routes\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[Laya](/docs/getting-started/providers/laya)","lvl3":""}},
6069
6069
  {"objectID":"613cbeca5e8fa0bbe765b8db9ec4ed2ff76a913dd45b8dab5e2de06a6e5f19ff","title":"[XOR](/docs/getting-started/providers/xor)","url":"/docs/getting-started/providers#xordocsgetting-startedprovidersxor","content":"Open-weights decision provider — the same typed boolean/choice/score answers as Jev, from xor-1.1, Juspay's Apache-2.0 model, at a deployment or LiteLLM proxy route you configure\n🧭 Serves decide only; built-in features use it when its key and base URL are set and no TypeSafe key, no AI_GATEWAY_API_KEY and no Laya key and base URL is\n🖼️ Takes up to 8 images or one video with a decision, as a Buffer, a local file path or a data: URL; TypeSafe and Laya refuse media before any request\n📏 Refuses more than about 200,000 estimated tokens of state before any network call\n🔌 No built-in endpoint: XOR_BASE_URL (or credentials.xor.baseURL) is the origin of a deployment or of a LiteLLM route to one; requests go to <base URL>/v1/systemone\n🔑 XOR_API_KEY is the key that endpoint accepts; on LiteLLM, the key's team must allow xor-1.1\n📦 Weights and setup: huggingface.co/juspay/xor\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[XOR](/docs/getting-started/providers/xor)","lvl3":""}},
@@ -6078,7 +6078,7 @@
6078
6078
  {"objectID":"4a9f1215efa688ab3b06a96110094955a704ea8cf9592a88af2ea489890b843d","title":"[Morph](/docs/getting-started/providers/morph)","url":"/docs/getting-started/providers#morphdocsgetting-startedprovidersmorph","content":"Morph v3 Large\n🤖 2 models; default morph-v3-large (262K context)\n⚠️ No tool calling — text generation and structured output only\n💳 Free tier requires a card on file (rate-limited to 5 req/min until added)\n✅ Roster verified 2026-09-05 (authenticated GET /v1/models)\n🔑 API key from morphllm.com/dashboard\n🔄 Aliases: morphllm\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[Morph](/docs/getting-started/providers/morph)","lvl3":""}},
6079
6079
  {"objectID":"fcfea6a44729a5765a03321c73b19f69132db535ba7e062fab39cb95ca8d5764","title":"[Novita AI](/docs/getting-started/providers/novita)","url":"/docs/getting-started/providers#novita-aidocsgetting-startedprovidersnovita","content":"zai-org/GLM-5.3 Flash\n🤖 5 models; default zai-org/glm-5.3-flash (128K context)\n🛠️ Native tool calling + structured output together\n💳 Free tier available\n✅ Roster verified 2026-09-05 (authenticated GET /openai/v1/models)\n🔑 API key from novita.ai/settings/key-management\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[Novita AI](/docs/getting-started/providers/novita)","lvl3":""}},
6080
6080
  {"objectID":"23b4b0b712252323ac86d0e25d5e5dbb0044b3283db208e511689d619d09f5fa","title":"[Upstage](/docs/getting-started/providers/upstage)","url":"/docs/getting-started/providers#upstagedocsgetting-startedprovidersupstage","content":"Solar Pro 4\n🤖 10 models; default solar-pro4 (512K context)\n🛠️ Native tool calling + structured output together\n💳 Free tier available\n✅ Roster verified 2026-09-03 (authenticated GET /v1/models)\n🔑 API key from console.upstage.ai/api-keys\n🔄 Aliases: solar\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[Upstage](/docs/getting-started/providers/upstage)","lvl3":""}},
6081
- {"objectID":"6cc12ff4170a3accfacac16eef391a2dfa5d9a8e0da239c647a08ba9f8c78929","title":"🎙️ Voice Providers {#voice-providers}","url":"/docs/getting-started/providers#-voice-providers-voice-providers","content":"Synthesize speech, transcribe audio, or run live voice sessions. Voice providers are separate from LLM providers — they handle audio I/O rather than text generation.","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"🎙️ Voice Providers {#voice-providers}","lvl3":""}},
6081
+ {"objectID":"55ccf2401143da1c3c1451313611e8d3bcab827b306862f8d5001afa5069f58d","title":"🎙️ Voice Providers","url":"/docs/getting-started/providers#voice-providers","content":"Synthesize speech, transcribe audio, or run live voice sessions. Voice providers are separate from LLM providers — they handle audio I/O rather than text generation.","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"🎙️ Voice Providers","lvl3":""}},
6082
6082
  {"objectID":"b0c947ddc7089afe19789acfbd8ddf97df792f98be2de9004e0d7c131d60ceea","title":"[OpenAI TTS](/docs/getting-started/providers/openai-tts)","url":"/docs/getting-started/providers#openai-ttsdocsgetting-startedprovidersopenai-tts","content":"Highest-quality text-to-speech\n🎙️ Voices: alloy, echo, fable, onyx, nova, shimmer\n🎵 Models: tts-1 (fast) and tts-1-hd (high quality)\n🎼 Formats: MP3, WAV, OGG, Opus\n🔑 Auth: API Key (OPENAI_API_KEY)\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[OpenAI TTS](/docs/getting-started/providers/openai-tts)","lvl3":""}},
6083
6083
  {"objectID":"e508f808a3c6ec30976b8517da643313ade57617b141e5660d41a5c8b31cf64b","title":"[ElevenLabs](/docs/getting-started/providers/elevenlabs)","url":"/docs/getting-started/providers#elevenlabsdocsgetting-startedproviderselevenlabs","content":"Best multilingual and voice-cloning TTS\n🌍 Supports 30+ languages with natural prosody\n🎭 Custom voice cloning from short audio samples\n🎼 Formats: MP3, WAV (raw PCM, surfaced as pcm16), Opus (Ogg container)\n🔑 Auth: API Key (ELEVENLABS_API_KEY)\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[ElevenLabs](/docs/getting-started/providers/elevenlabs)","lvl3":""}},
6084
6084
  {"objectID":"99f26adf90af871484d290a04c53d1194c4eaa7b76e5902d52f38c4e74b876a5","title":"[Google TTS](/docs/getting-started/provider-setup)","url":"/docs/getting-started/providers#google-ttsdocsgetting-startedprovider-setup","content":"1M characters/month free tier\n💰 Generous free tier for standard voices\n🌍 380+ voices across 50+ languages\n🎼 Formats: MP3, WAV, OGG\n🔑 Auth: Service Account\n\nSetup Guide →","hierarchy":{"lvl0":"Getting Started","lvl1":"AI Provider Guides","lvl2":"[Google TTS](/docs/getting-started/provider-setup)","lvl3":""}},
@@ -10224,7 +10224,7 @@
10224
10224
  {"objectID":"d1ef78abebd9e2c373354caf01ad1526bd831d48fc7c5c5155f10e3b78ca18e3","title":"Performance benchmark","url":"/docs/reference/troubleshooting#performance-benchmark","content":"npx @juspay/neurolink sagemaker benchmark my-endpoint","hierarchy":{"lvl0":"Reference","lvl1":"NeuroLink Troubleshooting Guide","lvl2":"Performance benchmark","lvl3":""}},
10225
10225
  {"objectID":"a03b60334f531a734f6778693dc5562e0351d021d017f69f8616190a5990c69b","title":"List available endpoints (requires AWS CLI)","url":"/docs/reference/troubleshooting#list-available-endpoints-requires-aws-cli","content":"npx @juspay/neurolink sagemaker list-endpoints\n`","hierarchy":{"lvl0":"Reference","lvl1":"NeuroLink Troubleshooting Guide","lvl2":"List available endpoints (requires AWS CLI)","lvl3":""}},
10226
10226
  {"objectID":"13a3b23023441d20f921cbafa7c3e44d6bc5430d34f0c8947585d4afca930a54","title":"Google Gemini: Function Calling + Schema Conflict","url":"/docs/reference/troubleshooting#google-gemini-function-calling-schema-conflict","content":"Symptom: Error when using schema with Google Vertex AI or Google AI Studio\n\nRoot Cause: Google's Gemini API fundamentally cannot combine function calling (tools) with structured output (JSON schema). This is a documented Google API limitation, not a NeuroLink bug.\n\nSolutions:\nDisable Tools (Recommended):\nUse Different Provider:\nUse Future Gemini Versions:\nFuture Gemini versions may support both -- check official documentation for updates\n\nThis is Industry Standard: All frameworks (LangChain, Vercel AI SDK, Agno, Instructor) use the same workaround.\n\nHistorical Context:\nGemini 2.0 and earlier: Cannot combine tools + schemas\nGemini 2.5: Worsened -- even fails with tool calls in conversation history\nGemini 3: Still cannot combine tools + schemas (same limitation applies)","hierarchy":{"lvl0":"Reference","lvl1":"NeuroLink Troubleshooting Guide","lvl2":"Google Gemini: Function Calling + Schema Conflict","lvl3":""}},
10227
- {"objectID":"64f64cba05d962f781c195f17b5446faeff87498bd5aef2104f04cba5be7a857","title":"Google Gemini: \"Too many states for serving\" Error {#google-gemini-too-many-states-for-serving-error}","url":"/docs/reference/troubleshooting#google-gemini-too-many-states-for-serving-error-google-gemini-too-many-states-for-serving-error","content":"Symptom: Error with complex Zod schemas on Google providers\n\nRoot Cause: Google Gemini has internal state limits. Complex schemas + many tools exceed these limits.\n\nSolutions:\nSimplify Schema:\nDisable Tools (reduces state complexity):\nUse Different Provider:\nOpenAI: No known schema complexity limits\nAnthropic: Handles deep nested schemas well","hierarchy":{"lvl0":"Reference","lvl1":"NeuroLink Troubleshooting Guide","lvl2":"Google Gemini: \"Too many states for serving\" Error {#google-gemini-too-many-states-for-serving-error}","lvl3":""}},
10227
+ {"objectID":"d2b108fd41eaefa3df6a408c1b9acaf146915f108f44f825b3a54b41c32cf30e","title":"Google Gemini: \"Too many states for serving\" Error","url":"/docs/reference/troubleshooting#google-gemini-too-many-states-for-serving-error","content":"Symptom: Error with complex Zod schemas on Google providers\n\nRoot Cause: Google Gemini has internal state limits. Complex schemas + many tools exceed these limits.\n\nSolutions:\nSimplify Schema:\nDisable Tools (reduces state complexity):\nUse Different Provider:\nOpenAI: No known schema complexity limits\nAnthropic: Handles deep nested schemas well","hierarchy":{"lvl0":"Reference","lvl1":"NeuroLink Troubleshooting Guide","lvl2":"Google Gemini: \"Too many states for serving\" Error","lvl3":""}},
10228
10228
  {"objectID":"6b92f63ca8f44e53c0f193caf4cd1ec77d4dc46febbab097fcf02039a5a88e66","title":"Command Not Found","url":"/docs/reference/troubleshooting#command-not-found","content":"Symptom: neurolink: command not found\n\nSolutions:\nUsing NPX (Recommended):\nGlobal Installation:\nLocal Project Usage:","hierarchy":{"lvl0":"Reference","lvl1":"NeuroLink Troubleshooting Guide","lvl2":"Command Not Found","lvl3":""}},
10229
10229
  {"objectID":"8b48d71ce9dc2773c7685160aae821a307244d8d6554bc02c87a22b33072e5c6","title":"Model Parameter Not Working","url":"/docs/reference/troubleshooting#model-parameter-not-working","content":"Symptom: CLI --model parameter is ignored, always uses default model\n\nExample Issue:\n\n`bash","hierarchy":{"lvl0":"Reference","lvl1":"NeuroLink Troubleshooting Guide","lvl2":"Model Parameter Not Working","lvl3":""}},
10230
10230
  {"objectID":"3304bec51944d9fa14e8e68e123d7e943f55926a12e0377b1ab0c71eda2900da","title":"Command specifies model but output shows default model being used","url":"/docs/reference/troubleshooting#command-specifies-model-but-output-shows-default-model-being-used","content":"node dist/cli/index.js generate \"test\" --provider google-ai --model gemini-2.5-flash","hierarchy":{"lvl0":"Reference","lvl1":"NeuroLink Troubleshooting Guide","lvl2":"Command specifies model but output shows default model being used","lvl3":""}},
@@ -10560,7 +10560,7 @@
10560
10560
  {"objectID":"67e25cb84e1a45413d246db21b885f83c9f9cd929f6c5b130208fdc7299645ed","title":"API Reference","url":"/docs/sdk/api-reference#api-reference","content":"Complete reference for NeuroLink's TypeScript API.","hierarchy":{"lvl0":"Sdk","lvl1":"API Reference","lvl2":"API Reference","lvl3":""}},
10561
10561
  {"objectID":"75a2e62a64c504c936e31eee81df59a23b4a5282186e916dda0e93b306c943b0","title":"NeuroLink Class","url":"/docs/sdk/api-reference#neurolink-class","content":"The NeuroLink class is the main entry point for all SDK functionality.","hierarchy":{"lvl0":"Sdk","lvl1":"API Reference","lvl2":"NeuroLink Class","lvl3":""}},
10562
10562
  {"objectID":"32e2583180be8785a68bc3b3e6f8e202e041a150f8fe091f824b8a3bf45fa0a2","title":"Constructor: new NeuroLink(config?)","url":"/docs/sdk/api-reference#constructor-new-neurolinkconfig","content":"Create a new NeuroLink instance with optional configuration for conversation memory, orchestration, HITL, and observability.\n\nParameters:\n\nExamples:\n\nSee also:\nRedis Conversation Export\nHuman-in-the-Loop (HITL)\nProvider Orchestration","hierarchy":{"lvl0":"Sdk","lvl1":"API Reference","lvl2":"Constructor: new NeuroLink(config?)","lvl3":""}},
10563
- {"objectID":"0e4a06c841f0098e5fd31b3a221e28e44163f84cc4f94c180b706f1695a76922","title":"generate(options) {#generate}","url":"/docs/sdk/api-reference#generateoptions-generate","content":"Generate text content synchronously.\n\nParameters:\n\nReturns:\n\nBasic Example:\n\nWith Analytics and Evaluation:\n\nWith Video Generation (Veo 3.1):\n\nNote: Video generation requires Vertex AI credentials and currently only supports Veo 3.1 model. See Video Generation Guide for complete documentation.","hierarchy":{"lvl0":"Sdk","lvl1":"API Reference","lvl2":"generate(options) {#generate}","lvl3":""}},
10563
+ {"objectID":"35d1b65e6ba5ec2dc7240c7861dcfd57b1ba0c547cc2ef53707d9ca10fef034c","title":"generate(options)","url":"/docs/sdk/api-reference#generate","content":"Generate text content synchronously.\n\nParameters:\n\nReturns:\n\nBasic Example:\n\nWith Analytics and Evaluation:\n\nWith Video Generation (Veo 3.1):\n\nNote: Video generation requires Vertex AI credentials and currently only supports Veo 3.1 model. See Video Generation Guide for complete documentation.","hierarchy":{"lvl0":"Sdk","lvl1":"API Reference","lvl2":"generate(options)","lvl3":""}},
10564
10564
  {"objectID":"b18968db6b2af6a05aea4f70a791c4e548476c7a26eabc4edb12fc7e947c32d9","title":"Schema Limitations by Provider","url":"/docs/sdk/api-reference#schema-limitations-by-provider","content":"Google Gemini Limitation (Vertex AI and Google AI Studio):\nCannot combine schema + tools (including built-in tools)\nSolution: Use disableTools: true when using schemas\nNote: This limitation applies to all Gemini models, including Gemini 3 models\n\nExample:\n\nProvider Support Matrix:\n\n| Provider | Tools + Schema | Notes |\n| ------------------ | ------------------------ | --------------------- |\n| OpenAI | Full Support | No limitations |\n| Anthropic | Full Support | No limitations |\n| Vertex AI (Gemini) | Use disableTools: true | Google API limitation |\n| Google AI Studio | Use disableTools: true | Google API limitation |\n| Vertex AI (Claude) | Full Support | Uses Anthropic models |\n| Azure OpenAI | Full Support | No limitations |\n| Bedrock | Full Support | No limitations |","hierarchy":{"lvl0":"Sdk","lvl1":"API Reference","lvl2":"Schema Limitations by Provider","lvl3":""}},
10565
10565
  {"objectID":"c4427ee44db90ee80e9d793a7c422e797e54060eedd9e4bd3d42f48095d7464f","title":"stream(options)","url":"/docs/sdk/api-reference#streamoptions","content":"Generate content with streaming responses.\n\nParameters:\n\nReturns:\n\nExample:","hierarchy":{"lvl0":"Sdk","lvl1":"API Reference","lvl2":"stream(options)","lvl3":""}},
10566
10566
  {"objectID":"517bf503c0fd729563d25fe09a7fe535d7acf840f493cb3a4e1b412078612948","title":"gen(options)","url":"/docs/sdk/api-reference#genoptions","content":"Short alias for generate(). Identical signature and behavior.","hierarchy":{"lvl0":"Sdk","lvl1":"API Reference","lvl2":"gen(options)","lvl3":""}},
@@ -10636,8 +10636,8 @@
10636
10636
  {"objectID":"eab2dda644f157a183417bd5a62e6b89ad2969b851553857c430fb4c0d97a822","title":"Documentation Sections","url":"/docs/sdk#documentation-sections","content":"API Reference — Complete TypeScript API documentation with interfaces, types, and method signatures.\nFramework Integration — Integration guides for Next.js, SvelteKit, React, Vue, and other popular frameworks.\nCustom Tools — How to create and register custom tools for enhanced AI capabilities.","hierarchy":{"lvl0":"Sdk","lvl1":"SDK Reference","lvl2":"Documentation Sections","lvl3":""}},
10637
10637
  {"objectID":"2e3627725e27cb6b405351c23ebea13afe1328e72e8f6563ad5ac419ae259a76","title":"Core Architecture","url":"/docs/sdk#core-architecture","content":"The SDK uses a Factory Pattern architecture that provides:\nUnified Interface: Providers implement the same AIProvider interface\nType Safety: Full TypeScript support with IntelliSense\nAutomatic Fallback: Seamless provider switching on failures\nBuilt-in Tools: 6 core tools available across supported providers","hierarchy":{"lvl0":"Sdk","lvl1":"SDK Reference","lvl2":"Core Architecture","lvl3":""}},
10638
10638
  {"objectID":"68026f701cebc6b98ea96c9e72cf6fedc9ee6e9e40a5ca1f521ce8d132c4cb0a","title":"Configuration","url":"/docs/sdk#configuration","content":"The SDK automatically detects configuration from:","hierarchy":{"lvl0":"Sdk","lvl1":"SDK Reference","lvl2":"Configuration","lvl3":""}},
10639
- {"objectID":"ce4be95a86c0aeace766e4f1b7537e817661c75e0b13161c2c142f76c7e46e1c","title":"Auto Provider Selection {#auto-selection}","url":"/docs/sdk#auto-provider-selection-auto-selection","content":"NeuroLink automatically selects the best available AI provider based on your configuration:\n\nSelection Priority:\nOpenAI (most reliable)\nAnthropic (high quality)\nGoogle AI Studio (free tier)\nOther configured providers\n\nCustom Priority:\n\nLearn more: Provider Orchestration Guide","hierarchy":{"lvl0":"Sdk","lvl1":"SDK Reference","lvl2":"Auto Provider Selection {#auto-selection}","lvl3":""}},
10640
- {"objectID":"22692664f53f5bf1fdc0b0e6b6b738b01db36ec4451e0454394e40a0e7e0fe9f","title":"Conversation Memory {#memory}","url":"/docs/sdk#conversation-memory-memory","content":"Automatic context management for multi-turn conversations:\n\nMemory Types:\nIn-Memory: Fast, single-instance only\nRedis: Distributed, persistent across restarts\n\nFeatures:\nAutomatic context window management\nSession isolation by ID\nExport/import conversation history\nContext summarization for long sessions\n\nLearn more:\nConversation Memory Deep Dive\nRedis Configuration\nContext Summarization","hierarchy":{"lvl0":"Sdk","lvl1":"SDK Reference","lvl2":"Conversation Memory {#memory}","lvl3":""}},
10639
+ {"objectID":"436f6bd7f20bc98d31b10d7028871349ea2d8ccbd40c521ed21b5bf2c0d84a86","title":"Auto Provider Selection","url":"/docs/sdk#auto-selection","content":"NeuroLink automatically selects the best available AI provider based on your configuration:\n\nSelection Priority:\nOpenAI (most reliable)\nAnthropic (high quality)\nGoogle AI Studio (free tier)\nOther configured providers\n\nCustom Priority:\n\nLearn more: Provider Orchestration Guide","hierarchy":{"lvl0":"Sdk","lvl1":"SDK Reference","lvl2":"Auto Provider Selection","lvl3":""}},
10640
+ {"objectID":"f01f4f677ca55cf82a9b20b31c87de1bc919a669f4d1eab82c79b7ab78ff59d6","title":"Conversation Memory","url":"/docs/sdk#memory","content":"Automatic context management for multi-turn conversations:\n\nMemory Types:\nIn-Memory: Fast, single-instance only\nRedis: Distributed, persistent across restarts\n\nFeatures:\nAutomatic context window management\nSession isolation by ID\nExport/import conversation history\nContext summarization for long sessions\n\nLearn more:\nConversation Memory Deep Dive\nRedis Configuration\nContext Summarization","hierarchy":{"lvl0":"Sdk","lvl1":"SDK Reference","lvl2":"Conversation Memory","lvl3":""}},
10641
10641
  {"objectID":"ae08239f7cd81c63d312138c68340b034033ce51ede6bf4d9d5cb450f188ba91","title":"Related Resources","url":"/docs/sdk#related-resources","content":"Examples & Tutorials - Practical implementation examples\nAdvanced Features - MCP integration, analytics, streaming\nTroubleshooting - Common issues and solutions","hierarchy":{"lvl0":"Sdk","lvl1":"SDK Reference","lvl2":"Related Resources","lvl3":""}},
10642
10642
  {"objectID":"bb156e86862b1212369b7227e84768d8964d9e99e680191400d9654b0df583d7","title":"NestJS Integration Guide","url":"/docs/sdk/nestjs-integration","content":"NestJS Integration Guide\n\nBuild enterprise-grade AI applications with NestJS and NeuroLink\n\nOverview\n\nNestJS is a progressive Node.js framework for building efficient, scalable server-side applications. Its architecture with modules, dependency injection, and decorators makes it ideal for enterprise AI applications.\n\nKey Features\n📦 Modules: Organized, scalable application architecture\n💉 Dependency Injection: Testable, loosely coupled services\n🛡️ Guards: Authentication and authorization patterns\n🔄 Interceptors: Cross-cutting concerns like caching and logging\n📝 Pipes: Request validation and transformation\n🚨 Exception Filters: Centralized error handling\n\nWhat You'll Build\nModular AI service architecture with dependency injection\nRESTful controllers with validation and decorators\nJWT and API key authentication guards\nRate limiting and response caching interceptors\nStreaming responses with Server-Sent Events\nProduction-ready deployment configuration\n\nQuick Start\nCreate New NestJS Project\nConfigure Environment\nGenerate Module and Controller\n\nModule Setup\n\nNeuroLink Module (Dynamic)\n\nNeuroLink Service (@Injectable)\n\nController Implementation\n\nAI Controller with Decorators\n\nDTOs and Validation\n\nGenerate DTO with class-validator\n\nChat DTO with Nested Validation\n\nStream DTO\n\nAuthentication\n\nAPI Key Guard\n\nJWT Auth Guard with @UseGuards\n\nPublic Decorator\n\nRate Limiting\n\nCustom RateLimitInterceptor\n\nUsing @nestjs/throttler\n\nResponse Caching\n\nCacheInterceptor with @nestjs/cache-manager\n\nStreaming Responses\n\nSSE with @Sse() Decorator\n\nException Filters\n\nAIExceptionFilter with @Catch()\n\nProduction Patterns\n\nHealth Check Module\n\nGraceful Shutdown\n\nMonitoring and Logging\n\nnestjs-pino for Structured Logging\n\nPrometheus with @willsoto/nestjs-prometheus\n\nBest Practices\n\nFollow these best practices when building NestJS AI applications:\nUse Dependency Injection - Inject NeuroLinkService instead of creating instances directly. This enables testing and lifecycle management.\nImplement Lifecycle Hooks - Use OnModuleInit for initialization and OnModuleDestroy for cleanup to ensure proper resource management.\nValidate All Inputs - Use DTOs with class-validator decorators and apply ValidationPipe globally to catch invalid requests early.\nCentralize Error Handling - Use exception filters to handle AI provider errors consistently across all endpoints.\nMonitor Everything - Implement Prometheus metrics for requests, latency, and errors. Use structured logging for debugging.\n\nDeployment\n\nDockerfile\n\ndocker-compose.yml\n\nProduction Checklist\n\nRelated Documentation\nExpress.js Integration Guide - Lightweight REST API setup\nNext.js Integration Guide - Full-stack React applications\nStreaming Guide - SSE and WebSocket streaming\nAPI Reference - Complete SDK documentation\n\nNeed Help?\nDocumentation: https://neurolink.dev/docs\nGitHub Issues: https://github.com/juspay/neurolink/issues\nDiscord Community: https://discord.gg/neurolink","hierarchy":{"lvl0":"Sdk","lvl1":"NestJS Integration Guide","lvl2":"","lvl3":""}},
10643
10643
  {"objectID":"c98a3654fcdda58400b9adf1800468a10b66ebd41a0e2a8cdaa434b3f9b62c2d","title":"NestJS Integration Guide","url":"/docs/sdk/nestjs-integration#nestjs-integration-guide","content":"Build enterprise-grade AI applications with NestJS and NeuroLink","hierarchy":{"lvl0":"Sdk","lvl1":"NestJS Integration Guide","lvl2":"NestJS Integration Guide","lvl3":""}},