String AI · 5 分钟上手指南

欢迎来到 String AI！这篇指南帮你用最短时间完成第一次对话，理解模型选择、余额查看和常见疑问。不写代码，不配工具，只看网页。

第一步：登录账号

1. 在浏览器中打开 String AI 网页入口。
2. 使用你的注册邮箱登录。如果还没注册，请联系管理员获取邀请链接或开通权限。
3. 登录成功后，页面右上角或侧边栏会显示你的账号信息（头像或邮箱）。看到它就说明登录成功了。

如果登录失败，请依次检查：

• 邮箱地址是否与注册时一致（注意大小写和空格）
• 垃圾邮件箱里是否有验证码或邀请邮件
• 浏览器是否开启了弹窗拦截（部分第三方登录会弹出新窗口）
• 公司网络或代理是否限制了登录页面
• 尝试用浏览器的无痕模式重新打开

第二步：完成第一次提问

登录后你会进入 Webchat 页面。在输入框里直接输入下面的文字，按下回车：

你是谁？用三句话介绍你可以帮我做什么。

然后你会看到 AI 开始逐字输出回复。

如果页面正常回复了，恭喜，你已经会用了。

这就跟你平时发微信一样 —— 打字、发送、看回复。接下来可以试试这些问题，感受一下 AI 能干什么：

一个小建议： 每次开始一个新任务时，点击「新建对话」按钮开一个新对话。如果把写邮件、翻译、总结全部塞在同一个对话里，AI 可能会把前面的内容混在一起，回答反而变乱。

第三步：选择模型

模型就像 AI 的「大脑」，不同模型有不同的特点和价格。你会在输入框上方或旁边看到一个模型选择器。

不知道怎么选？记住这条原则就行：先选默认模型，遇到问题再换。

一个简单的判断方法：

• 你想要质量高 → 选更强的模型
• 你想要速度快、省钱 → 选轻量模型
• 你不确定 → 选默认模型，永远不会错

随着使用次数多了，你会慢慢形成自己的偏好，不需要一开始就纠结。

第四步：查看余额和用量

在你开始大量使用之前，建议花一分钟搞清楚三件事：

1. 当前余额或剩余额度是多少 —— 这决定你还能用多久。一般在页面右上角头像附近，或「设置 / 账户」页面里。
2. 每次对话大概消耗多少 —— 可以在「消耗记录」页面看到每次调用的详细用量。短问答消耗较少，长文档、多轮深度对话消耗较多。
3. 是否按模型区分价格 —— 不同模型的单价不同，强模型通常更贵，轻量模型更便宜。

影响消耗的主要因素：

省钱小技巧：

• 新任务新对话：不要在一个对话里塞太多话题
• 长文档先让 AI 列出提纲，再分段深入
• 简单任务用轻量模型
• 隔几天看一眼消耗记录，心里有数

第五步：最常见的三个新手问题

Q1：模型太多了，我不知道选哪个

先用默认模型。 它适合 80% 的日常任务。只有当你发现「回复质量不够好」「要处理的东西太长」「成本太高了」的时候，再切到其他模型。不要在一开始就把所有模型都试一遍 —— 会累死。

Q2：余额和消耗到底怎么算的，为什么每次不一样

消耗跟你选的模型、输入内容长短、AI 回复长短、是否上传了文件、历史对话轮数都有关系。简单说：给 AI 喂的东西越多、让 AI 产出的越多、用的模型越强，消耗就越大。不需要盯着每次的数字看 —— 关注总余额和消耗趋势就够了。

Q3：我需要在电脑上装什么软件吗

完全不需要。 只要你能打开浏览器，就能用 Webchat。那些 VS Code、Codex、Cursor 之类的工具配置，是给开发者用的。如果你只是想在网页上提问、写作、翻译、总结，什么都不用装。

String AI · 5 分钟上手指南

歡迎來到 String AI！这篇指南幫你用最短時間完成第一次對話，理解模型選擇、餘額查看和常見疑問。不寫代碼，不配工具，只看網頁。

第一步：登錄帳號

1. 在瀏覽器中打開 String AI 網頁入口。
2. 使用你的註冊信箱登錄。如果還沒註冊，請聯絡管理員獲取邀請連結或開通權限。
3. 登錄成功後，頁面右上角或側邊欄會顯示你的帳號資訊（頭像或信箱）。看到它就說明登錄成功了。

如果登錄失敗，請依次檢查：

• 信箱地址是否與註冊時一致（注意大小寫和空格）
• 垃圾郵件箱里是否有驗證碼或邀請郵件
• 瀏覽器是否開啟了彈窗攔截（部分第三方登錄會彈出新窗口）
• 公司網絡或代理是否限制了登錄頁面
• 嘗試用瀏覽器的無痕模式重新打開

第二步：完成第一次提問

登錄後你會進入 Webchat 頁面。在輸入框里直接輸入下面的文字，按下回車：

你是谁？用三句话介绍你可以帮我做什么。

然後你會看到 AI 開始逐字輸出回複。

如果頁面正常回複了，恭喜，你已經會用了。

这就跟你平時發微信一樣 —— 打字、發送、看回複。接下來可以試試这些問題，感受一下 AI 能干什么：

一個小建議： 每次開始一個新任務時，點擊「新建對話」按钮開一個新對話。如果把寫郵件、翻譯、總結全部塞在同一個對話里，AI 可能會把前面的內容混在一起，回答反而變亂。

第三步：選擇模型

模型就像 AI 的「大腦」，不同模型有不同的特點和價格。你會在輸入框上方或旁邊看到一個模型選擇器。

不知道怎么選？記住这條原則就行：先選默認模型，遇到問題再換。

一個簡單的判斷方法：

• 你想要質量高 → 選更強的模型
• 你想要速度快、省錢 → 選輕量模型
• 你不確定 → 選默認模型，永遠不會錯

隨着使用次數多了，你會慢慢形成自己的偏好，不需要一開始就纠結。

第四步：查看餘額和用量

在你開始大量使用之前，建議花一分钟搞清楚三件事：

1. 當前餘額或剩餘額度是多少 —— 这決定你還能用多久。一般在頁面右上角頭像附近，或「設置 / 帳戶」頁面里。
2. 每次對話大概消耗多少 —— 可以在「消耗記錄」頁面看到每次調用的詳細用量。短問答消耗較少，長文檔、多輪深度對話消耗較多。
3. 是否按模型區分價格 —— 不同模型的單價不同，強模型通常更貴，輕量模型更便宜。

影響消耗的主要因素：

省錢小技巧：

• 新任務新對話：不要在一個對話里塞太多話題
• 長文檔先讓 AI 列出提纲，再分段深入
• 簡單任務用輕量模型
• 隔幾天看一眼消耗記錄，心里有數

第五步：最常見的三個新手問題

Q1：模型太多了，我不知道選哪個

先用默認模型。 它適合 80% 的日常任務。只有當你發現「回複質量不够好」「要處理的東西太長」「成本太高了」的時候，再切到其他模型。不要在一開始就把所有模型都試一遍 —— 會累死。

Q2：餘額和消耗到底怎么算的，為什么每次不一樣

消耗跟你選的模型、輸入內容長短、AI 回複長短、是否上傳了文件、歷史對話輪數都有關系。簡單說：給 AI 喂的東西越多、讓 AI 產出的越多、用的模型越強，消耗就越大。不需要盯着每次的數字看 —— 關注總餘額和消耗趋勢就够了。

Q3：我需要在電腦上裝什么軟件吗

完全不需要。 只要你能打開瀏覽器，就能用 Webchat。那些 VS Code、Codex、Cursor 之類的工具設定，是給開發者用的。如果你只是想在網頁上提問、寫作、翻譯、總結，什么都不用裝。

String AI - 5 मिनट में शुरुआत मार्गदर्शिका

String AI में आपका स्वागत है। यह मार्गदर्शिका आपको पहली बातचीत पूरी करने, मॉडल चयन समझने, शेष राशि और उपयोग देखने, और नए उपयोगकर्ताओं के सबसे आम सवालों के जवाब पाने में मदद करती है। इसके लिए कोड लिखने या कोई टूल कॉन्फ़िगर करने की जरूरत नहीं है; बस वेब ऐप इस्तेमाल करें।

चरण 1: अपने खाते में लॉग इन करें

1. ब्राउज़र में String AI का वेब प्रवेश खोलें।
2. अपने पंजीकृत ईमेल पते से लॉग इन करें। अगर आपने अभी पंजीकरण नहीं किया है, तो आमंत्रण लिंक या प्रवेश अधिकार के लिए अपने व्यवस्थापक से संपर्क करें।
3. लॉगिन के बाद ऊपर दाएँ कोने या साइडबार में आपके खाते की जानकारी, अवतार या ईमेल दिखना चाहिए। अगर यह दिख रहा है, तो लॉगिन सफल है।

अगर लॉगिन असफल हो, तो ये बातें जांचें:

• ईमेल पता पंजीकरण में इस्तेमाल हुए ईमेल से मेल खाता है या नहीं, खाली जगहों और अक्षरों के आकार सहित
• सत्यापन कोड या आमंत्रण ईमेल स्पैम फ़ोल्डर में तो नहीं गया
• ब्राउज़र पॉप-अप रोक तो नहीं रहा, क्योंकि कुछ तृतीय-पक्ष लॉगिन प्रक्रियाएँ नई विंडो खोलती हैं
• कंपनी का नेटवर्क या प्रॉक्सी लॉगिन पेज को रोक तो नहीं रहा
• गुप्त ब्राउज़र विंडो में लॉगिन काम करता है या नहीं

चरण 2: अपना पहला प्रश्न पूछें

लॉगिन के बाद आप Webchat पेज पर पहुँचेंगे। इनपुट बॉक्स में यह संदेश लिखें और Enter दबाएँ:

आप कौन हैं? तीन वाक्यों में बताइए कि आप मेरी किस तरह मदद कर सकते हैं।

आपको AI का उत्तर धीरे-धीरे दिखाई देना शुरू होना चाहिए।

अगर पेज सामान्य रूप से उत्तर देता है, तो बधाई हो। अब आप String AI इस्तेमाल करने के लिए तैयार हैं।

यह सामान्य चैट ऐप की तरह काम करता है: लिखें, भेजें, और उत्तर पढ़ें। AI क्या कर सकता है, यह समझने के लिए ये उदाहरण आजमाएँ:

छोटी सलाह: हर नए काम के लिए नई बातचीत शुरू करें। अगर ईमेल लिखना, अनुवाद और सारांश एक ही लंबी बातचीत में मिला दिए जाएँ, तो AI पुराने संदर्भ को बाद के उत्तरों में मिला सकता है।

चरण 3: मॉडल चुनें

मॉडल AI का "मस्तिष्क" है। अलग-अलग मॉडल की क्षमताएँ और कीमतें अलग होती हैं। इनपुट बॉक्स के पास आपको मॉडल चयनकर्ता दिखेगा।

समझ न आए कि कौन सा मॉडल चुनें? डिफ़ॉल्ट मॉडल से शुरू करें और जरूरत पड़ने पर ही बदलें।

एक सरल नियम:

• अधिक गुणवत्ता चाहिए -> अधिक शक्तिशाली मॉडल चुनें
• तेज़ और सस्ता उत्तर चाहिए -> हल्का मॉडल चुनें
• निश्चित नहीं हैं -> डिफ़ॉल्ट मॉडल इस्तेमाल करें

String AI कुछ समय इस्तेमाल करने के बाद आपको स्वाभाविक रूप से समझ आने लगेगा कि कौन से मॉडल आपके काम के लिए उपयुक्त हैं।

चरण 4: शेष राशि और उपयोग देखें

अधिक उपयोग शुरू करने से पहले एक मिनट निकालकर ये तीन बातें समझ लें:

1. आपकी मौजूदा शेष राशि या बची हुई सीमा - इससे तय होता है कि आप सेवा कितनी देर तक इस्तेमाल कर सकते हैं। यह आम तौर पर अवतार के पास या Settings / Account में मिलती है।
2. हर बातचीत की लागत - उपयोग इतिहास पेज हर अनुरोध की विस्तृत खपत दिखाता है। छोटे प्रश्नोत्तर की लागत कम होती है; लंबे दस्तावेज़ और बहु-चरणीय तर्क अधिक खर्च करते हैं।
3. क्या कीमत मॉडल के अनुसार बदलती है - अधिक शक्तिशाली मॉडल आम तौर पर महंगे होते हैं, जबकि हल्के मॉडल सस्ते होते हैं।

उपयोग को प्रभावित करने वाले मुख्य कारण:

लागत बचाने के उपाय:

• नए काम के लिए नई बातचीत शुरू करें
• पहले रूपरेखा माँगें, फिर हर भाग पर अलग-अलग विस्तार करें
• सरल कामों के लिए हल्के मॉडल इस्तेमाल करें
• हर कुछ दिनों में उपयोग रिकॉर्ड देखें ताकि खर्च का रुझान समझ में रहे

चरण 5: नए उपयोगकर्ताओं के तीन आम सवाल

Q1: मॉडल बहुत अधिक हैं। मुझे कौन सा चुनना चाहिए?

पहले डिफ़ॉल्ट मॉडल इस्तेमाल करें। यह ज्यादातर रोज़मर्रा के कामों के लिए पर्याप्त है। उत्तर की गुणवत्ता कम लगे, सामग्री बहुत लंबी हो, या लागत बहुत अधिक हो तभी मॉडल बदलें। शुरुआत में हर मॉडल आजमाने की जरूरत नहीं है।

Q2: शेष राशि और उपयोग की गणना कैसे होती है? हर अनुरोध अलग क्यों होता है?

उपयोग मॉडल, इनपुट की लंबाई, आउटपुट की लंबाई, फ़ाइल अपलोड और बातचीत के इतिहास पर निर्भर करता है। संक्षेप में: आप AI को जितनी अधिक सामग्री देंगे, उससे जितना अधिक उत्तर बनवाएँगे, और मॉडल जितना अधिक शक्तिशाली होगा, लागत उतनी अधिक होगी। हर संख्या पर नज़र रखने की जरूरत नहीं है। कुल शेष राशि और उपयोग के रुझान पर ध्यान दें।

Q3: क्या मुझे अपने कंप्यूटर पर कुछ install करना होगा?

नहीं। अगर आप ब्राउज़र खोल सकते हैं, तो Webchat इस्तेमाल कर सकते हैं। VS Code, Codex और Cursor जैसे टूल डेवलपरों के लिए हैं। अगर आप वेब पर सिर्फ प्रश्न पूछना, लिखना, अनुवाद करना या सारांश बनाना चाहते हैं, तो कुछ install करने की जरूरत नहीं है।

String AI - 5-Minute Getting Started Guide

Welcome to String AI. This guide helps you complete your first conversation, understand model selection, check balance and usage, and answer the most common beginner questions. No code, no tool configuration, just the web app.

Step 1: Log in to your account

1. Open the String AI web entry in your browser.
2. Log in with your registered email address. If you have not registered yet, contact your administrator for an invitation link or access.
3. After login, your account information, avatar, or email should appear in the top-right corner or sidebar. If you can see it, login succeeded.

If login fails, check the following:

• Whether the email address matches the one used during registration, including spaces and casing
• Whether the verification code or invitation email is in spam
• Whether your browser blocks pop-ups, because some third-party login flows open a new window
• Whether your company network or proxy restricts the login page
• Whether an incognito browser window works

Step 2: Ask your first question

After login, you will enter the Webchat page. Type the following message into the input box and press Enter:

Who are you? In three sentences, explain what you can help me do.

You should see the AI start streaming a response.

If the page replies normally, congratulations. You are ready to use String AI.

It works like a normal chat app: type, send, and read the reply. Try these examples to get a feel for what AI can do:

Small tip: Start a new conversation for each new task. If you mix email writing, translation, and summarization in one long conversation, the AI may blend earlier context into later answers.

Step 3: Choose a model

A model is the AI "brain". Different models have different capabilities and prices. You will see a model selector near the input box.

Not sure which one to choose? Start with the default model and switch only when needed.

A simple rule:

• Want higher quality -> choose a stronger model
• Want faster and cheaper output -> choose a lightweight model
• Not sure -> use the default model

After using String AI for a while, you will naturally learn which models fit your own workflow.

Step 4: Check balance and usage

Before heavy usage, spend one minute understanding three things:

1. Your current balance or remaining quota - this determines how long you can continue using the service. It is usually near your avatar or under Settings / Account.
2. How much each conversation costs - the usage history page shows detailed consumption for each request. Short Q&A costs less; long documents and multi-turn reasoning cost more.
3. Whether pricing differs by model - stronger models are usually more expensive, while lightweight models are cheaper.

Main factors that affect usage:

Cost-saving tips:

• Start a new conversation for a new task
• Ask for an outline first, then go deeper section by section
• Use lightweight models for simple tasks
• Check usage records every few days so you know the trend

Step 5: Three common beginner questions

Q1: There are too many models. Which one should I choose?

Use the default model first. It works for most daily tasks. Switch only when response quality is not enough, the material is too long, or cost becomes too high. Do not try every model at the beginning.

Q2: How are balance and usage calculated? Why is every request different?

Usage depends on the model, input length, output length, file uploads, and conversation history. In short: the more you give the AI, the more you ask it to generate, and the stronger the model, the more it costs. You do not need to watch every single number. Focus on total balance and usage trend.

Q3: Do I need to install anything on my computer?

No. If you can open a browser, you can use Webchat. Tools such as VS Code, Codex, and Cursor are for developers. If you only want to ask questions, write, translate, or summarize on the web, you do not need to install anything.

前置：安装 Node.js 运行环境

Claude Code、Gemini CLI、Codex、OpenClaw 等工具都依赖 Node.js。建议先安装 LTS 版本。

Windows

方法一（推荐）：前往 Node.js 官网 下载 LTS 版本，双击安装。

方法二 / 三（包管理器）：

choco install nodejs-lts
# 或
scoop install nodejs-lts

macOS

brew install node
# 或前往官网下载 macOS 安装包

Linux

# Ubuntu / Debian
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs

# CentOS / RHEL
curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
sudo yum install -y nodejs

验证安装

node --version
npm --version

输出版本号即表示安装成功。

前置：安裝 Node.js 運行環境

Claude Code、Gemini CLI、Codex、OpenClaw 等工具都依賴 Node.js。建議先安裝 LTS 版本。

Windows

方法一（推薦）：前往 Node.js 官網 下載 LTS 版本，雙擊安裝。

方法二 / 三（包管理器）：

choco install nodejs-lts
# 或
scoop install nodejs-lts

macOS

brew install node
# 或前往官网下载 macOS 安装包

Linux

# Ubuntu / Debian
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs

# CentOS / RHEL
curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
sudo yum install -y nodejs

驗證安裝

node --version
npm --version

輸出版本號即表示安裝成功。

पूर्व आवश्यकता: Node.js रनटाइम इंस्टाल करें

Claude Code, Gemini CLI, Codex, OpenClaw और इसी तरह के टूल Node.js पर निर्भर करते हैं। पहले LTS संस्करण इंस्टाल करें।

Windows

पहला विकल्प, अनुशंसित: Node.js वेबसाइट पर जाएँ और LTS संस्करण इंस्टाल करें।

दूसरा और तीसरा विकल्प, पैकेज मैनेजर के साथ:

choco install nodejs-lts
# or
scoop install nodejs-lts

macOS

brew install node
# या आधिकारिक वेबसाइट से macOS इंस्टालर डाउनलोड करें

Linux

# Ubuntu / Debian
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs

# CentOS / RHEL
curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
sudo yum install -y nodejs

स्थापना सत्यापित करें

node --version
npm --version

अगर दोनों कमांड संस्करण संख्याएँ दिखाती हैं, तो Node.js और npm तैयार हैं।

Prerequisite: Install the Node.js Runtime

Claude Code, Gemini CLI, Codex, OpenClaw, and similar tools depend on Node.js. Install the LTS version first.

Windows

Option one, recommended: go to the Node.js website and install the LTS version.

Options two and three, using package managers:

choco install nodejs-lts
# or
scoop install nodejs-lts

macOS

brew install node
# or download the macOS installer from the official website

Linux

# Ubuntu / Debian
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs

# CentOS / RHEL
curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
sudo yum install -y nodejs

Verify Installation

node --version
npm --version

If both commands print version numbers, Node.js and npm are ready.

开始前先确认：是否已经安装 Node.js？请执行 node --version 和 npm --version。若没有版本号，请先完成 安装 Node.js 运行环境。

Codex（CLI 与 VS Code 插件）

Codex CLI 和 VS Code Codex 插件共用配置文件 ~/.codex/config.toml。

可用模型：gpt-5.5、gpt-5.4、gpt-5.4-mini。

方式一：一键脚本（推荐）

脚本会检查 Node.js 与 Codex CLI、提示输入 API Key，并把配置写入 ~/.codex。如已设置 STRING_AI_API_KEY 环境变量则优先使用，且不会读取本机已有的 OPENAI_API_KEY。

# Windows PowerShell
irm https://www.string.ink/install/codex.ps1 | iex

配置写入后 Codex CLI 与 App 客户端会同时生效；已打开的 CLI 需重启后才读取新配置。

方式二：手动创建配置

一键脚本不可用时，手动创建 config.toml 与 auth.json。

最简配置：

model_provider = "OpenAI"
model = "gpt-5.5"

[model_providers.OpenAI]
base_url = "https://www.string.ink/v1"

完整手动安装（Windows PowerShell，含备份与 auth.json）：

$codexDir = "$env:USERPROFILE\.codex"
if (-not (Test-Path $codexDir)) { mkdir $codexDir | Out-Null }
if (Test-Path "$codexDir\config.toml") {
  Copy-Item "$codexDir\config.toml" "$codexDir\config.toml.bak.$(Get-Date -Format yyyyMMddHHmmss)"
}
if (Test-Path "$codexDir\auth.json") {
  Copy-Item "$codexDir\auth.json" "$codexDir\auth.json.bak.$(Get-Date -Format yyyyMMddHHmmss)"
}
@"
model_provider = "OpenAI"
model = "gpt-5.5"
review_model = "gpt-5.5"
model_reasoning_effort = "xhigh"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true

[model_providers.OpenAI]
name = "OpenAI"
base_url = "https://www.string.ink/v1"
wire_api = "responses"
requires_openai_auth = true

[features]
goals = true
"@ | Out-File -FilePath "$codexDir\config.toml" -Encoding utf8

@"
{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}
"@ | Out-File -FilePath "$codexDir\auth.json" -Encoding utf8

配置完成后重启 Codex CLI 或 Codex App 客户端。

迁移 OAuth 旧会话（可选）

若之前用 Codex OAuth 登录，安装后旧会话可能因 provider 从内置 openai 切换到 OpenAI 而暂时不显示（不会被删除）。确认 config.toml 已是 model_provider = "OpenAI" 后，可运行迁移脚本，先预览再执行：

# Windows PowerShell
.\scripts\codex-migrate-provider.ps1 --dryrun
.\scripts\codex-migrate-provider.ps1

# macOS / Linux / WSL
scripts/codex-migrate-provider.sh --dryrun
scripts/codex-migrate-provider.sh

脚本默认把旧 openai 会话迁移到当前 provider，写入前要求输入 MIGRATE 确认，并备份受影响的 SQLite 与 session JSONL，可据 backup 目录回滚。如旧会话来自其它自定义 provider，用 -From 显式指定来源。

验证配置

在 Codex / VS Code 中发起一个简单任务：

请阅读当前项目结构，并用中文总结这个项目可能是做什么的。不要修改文件。

若 Codex 正常回复且 String AI 后台出现对应消耗记录，说明配置成功。

開始前先確認：是否已經安裝 Node.js？請執行 node --version 和 npm --version。若沒有版本號，請先完成 安裝 Node.js 運行環境。

Codex（CLI 與 VS Code 插件）

Codex CLI 和 VS Code Codex 插件共用設定文件 ~/.codex/config.toml。

可用模型：gpt-5.5、gpt-5.4、gpt-5.4-mini。

方式一：一鍵腳本（推薦）

腳本會檢查 Node.js 與 Codex CLI、提示輸入 API Key，並把設定寫入 ~/.codex。如已設置 STRING_AI_API_KEY 環境變量則優先使用，且不會讀取本機已有的 OPENAI_API_KEY。

# Windows PowerShell
irm https://www.string.ink/install/codex.ps1 | iex

設定寫入後 Codex CLI 與 App 客戶端會同時生效；已打開的 CLI 需重啟後才讀取新設定。

方式二：手動創建設定

一鍵腳本不可用時，手動創建 config.toml 與 auth.json。

最簡設定：

model_provider = "OpenAI"
model = "gpt-5.5"

[model_providers.OpenAI]
base_url = "https://www.string.ink/v1"

完整手動安裝（Windows PowerShell，含備份與 auth.json）：

$codexDir = "$env:USERPROFILE\.codex"
if (-not (Test-Path $codexDir)) { mkdir $codexDir | Out-Null }
if (Test-Path "$codexDir\config.toml") {
  Copy-Item "$codexDir\config.toml" "$codexDir\config.toml.bak.$(Get-Date -Format yyyyMMddHHmmss)"
}
if (Test-Path "$codexDir\auth.json") {
  Copy-Item "$codexDir\auth.json" "$codexDir\auth.json.bak.$(Get-Date -Format yyyyMMddHHmmss)"
}
@"
model_provider = "OpenAI"
model = "gpt-5.5"
review_model = "gpt-5.5"
model_reasoning_effort = "xhigh"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true

[model_providers.OpenAI]
name = "OpenAI"
base_url = "https://www.string.ink/v1"
wire_api = "responses"
requires_openai_auth = true

[features]
goals = true
"@ | Out-File -FilePath "$codexDir\config.toml" -Encoding utf8

@"
{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}
"@ | Out-File -FilePath "$codexDir\auth.json" -Encoding utf8

設定完成後重啟 Codex CLI 或 Codex App 客戶端。

遷移 OAuth 舊會話（可選）

若之前用 Codex OAuth 登錄，安裝後舊會話可能因 provider 從內置 openai 切換到 OpenAI 而暫時不顯示（不會被刪除）。確認 config.toml 已是 model_provider = "OpenAI" 後，可運行遷移腳本，先預覽再執行：

# Windows PowerShell
.\scripts\codex-migrate-provider.ps1 --dryrun
.\scripts\codex-migrate-provider.ps1

# macOS / Linux / WSL
scripts/codex-migrate-provider.sh --dryrun
scripts/codex-migrate-provider.sh

腳本默認把舊 openai 會話遷移到當前 provider，寫入前要求輸入 MIGRATE 確認，並備份受影響的 SQLite 與 session JSONL，可據 backup 目錄回滾。如舊會話來自其它自定義 provider，用 -From 顯式指定來源。

驗證設定

在 Codex / VS Code 中發起一個簡單任務：

请阅读当前项目结构，并用中文总结这个项目可能是做什么的。不要修改文件。

若 Codex 正常回複且 String AI 後台出現對應消耗記錄，說明設定成功。

शुरू करने से पहले: क्या आपने Node.js स्थापित कर लिया है? node --version और npm --version चलाएँ। अगर version numbers नहीं दिखते, तो पहले Node.js runtime स्थापित करें पूरा करें।

Codex (CLI और VS Code एक्सटेंशन)

Codex CLI और VS Code Codex एक्सटेंशन एक ही कॉन्फ़िगरेशन फ़ाइल इस्तेमाल करते हैं: ~/.codex/config.toml।

उपलब्ध मॉडल: gpt-5.5, gpt-5.4, gpt-5.4-mini।

विकल्प 1: एक-पंक्ति स्क्रिप्ट (अनुशंसित)

यह स्क्रिप्ट Node.js और Codex CLI की जाँच करती है, आपसे API Key माँगती है, और कॉन्फ़िगरेशन को ~/.codex में लिखती है। अगर STRING_AI_API_KEY पहले से सेट है, तो स्क्रिप्ट पहले उसी मान का उपयोग करती है और मौजूद OPENAI_API_KEY को नहीं पढ़ती।

# Windows PowerShell
irm https://www.string.ink/install/codex.ps1 | iex

कॉन्फ़िगरेशन लिखने के बाद Codex CLI और ऐप क्लाइंट दोनों इसका उपयोग करेंगे। नई कॉन्फ़िगरेशन लोड कराने के लिए खुले हुए CLI, VS Code या Codex क्लाइंट को दोबारा शुरू करें।

विकल्प 2: मैनुअल कॉन्फ़िगरेशन

अगर एक-पंक्ति स्क्रिप्ट उपलब्ध नहीं है, तो config.toml और auth.json हाथ से बनाएँ।

न्यूनतम कॉन्फ़िगरेशन:

model_provider = "OpenAI"
model = "gpt-5.5"

[model_providers.OpenAI]
base_url = "https://www.string.ink/v1"

Windows PowerShell के लिए पूरा मैनुअल सेटअप, बैकअप और auth.json सहित:

$codexDir = "$env:USERPROFILE\.codex"
if (-not (Test-Path $codexDir)) { mkdir $codexDir | Out-Null }
if (Test-Path "$codexDir\config.toml") {
  Copy-Item "$codexDir\config.toml" "$codexDir\config.toml.bak.$(Get-Date -Format yyyyMMddHHmmss)"
}
if (Test-Path "$codexDir\auth.json") {
  Copy-Item "$codexDir\auth.json" "$codexDir\auth.json.bak.$(Get-Date -Format yyyyMMddHHmmss)"
}
@"
model_provider = "OpenAI"
model = "gpt-5.5"
review_model = "gpt-5.5"
model_reasoning_effort = "xhigh"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true

[model_providers.OpenAI]
name = "OpenAI"
base_url = "https://www.string.ink/v1"
wire_api = "responses"
requires_openai_auth = true

[features]
goals = true
"@ | Out-File -FilePath "$codexDir\config.toml" -Encoding utf8

@"
{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}
"@ | Out-File -FilePath "$codexDir\auth.json" -Encoding utf8

कॉन्फ़िगरेशन पूरी होने के बाद Codex CLI या Codex ऐप क्लाइंट को दोबारा शुरू करें।

पुराने OAuth सत्र को माइग्रेट करें (वैकल्पिक)

अगर आपने पहले Codex में OAuth से login किया था, तो प्रदाता को अंतर्निहित openai से OpenAI पर बदलने के बाद पुराना सत्र कुछ समय के लिए गायब लग सकता है। वह हटता नहीं। config.toml में model_provider = "OpenAI" होने की पुष्टि करें, फिर माइग्रेशन स्क्रिप्ट चलाएँ। पहले पूर्वावलोकन करें, फिर असली बदलाव लागू करें:

# Windows PowerShell
.\scripts\codex-migrate-provider.ps1 --dryrun
.\scripts\codex-migrate-provider.ps1

# macOS / Linux / WSL
scripts/codex-migrate-provider.sh --dryrun
scripts/codex-migrate-provider.sh

स्क्रिप्ट डिफ़ॉल्ट रूप से पुराने openai सत्रों को वर्तमान प्रदाता पर माइग्रेट करती है। बदलाव लिखने से पहले यह आपसे MIGRATE लिखने को कहती है और प्रभावित SQLite तथा सत्र JSONL फ़ाइलों का बैकअप बनाती है। जरूरत पड़ने पर बैकअप निर्देशिका से रोलबैक किया जा सकता है। अगर पुराना सत्र किसी दूसरे कस्टम प्रदाता से आया था, तो उसे -From से निर्दिष्ट करें।

कॉन्फ़िगरेशन सत्यापित करें

Codex या VS Code में यह सरल कार्य चलाएँ:

Read the current project structure and summarize what this project may do. Do not modify files.

अगर Codex सामान्य रूप से उत्तर देता है और String AI कंसोल में संबंधित उपयोग रिकॉर्ड दिखता है, तो कॉन्फ़िगरेशन काम कर रही है।

Before you start: have you installed Node.js? Run node --version and npm --version. If they do not print version numbers, finish Install the Node.js Runtime first.

Codex (CLI and VS Code Extension)

Codex CLI and the VS Code Codex extension share the same configuration file: ~/.codex/config.toml.

Available models: gpt-5.5, gpt-5.4, gpt-5.4-mini.

Option 1: One-Line Script (Recommended)

The script checks Node.js and Codex CLI, asks for your API Key, and writes the configuration to ~/.codex. If STRING_AI_API_KEY is already set, it uses that value first and does not read an existing OPENAI_API_KEY.

# Windows PowerShell
irm https://www.string.ink/install/codex.ps1 | iex

After writing the configuration, Codex CLI and the app client will both use it. Restart any open CLI, VS Code, or Codex client so the new configuration is loaded.

Option 2: Manual Configuration

If the one-line script is unavailable, create config.toml and auth.json manually.

Minimal configuration:

model_provider = "OpenAI"
model = "gpt-5.5"

[model_providers.OpenAI]
base_url = "https://www.string.ink/v1"

Full manual setup for Windows PowerShell, including backups and auth.json:

$codexDir = "$env:USERPROFILE\.codex"
if (-not (Test-Path $codexDir)) { mkdir $codexDir | Out-Null }
if (Test-Path "$codexDir\config.toml") {
  Copy-Item "$codexDir\config.toml" "$codexDir\config.toml.bak.$(Get-Date -Format yyyyMMddHHmmss)"
}
if (Test-Path "$codexDir\auth.json") {
  Copy-Item "$codexDir\auth.json" "$codexDir\auth.json.bak.$(Get-Date -Format yyyyMMddHHmmss)"
}
@"
model_provider = "OpenAI"
model = "gpt-5.5"
review_model = "gpt-5.5"
model_reasoning_effort = "xhigh"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true

[model_providers.OpenAI]
name = "OpenAI"
base_url = "https://www.string.ink/v1"
wire_api = "responses"
requires_openai_auth = true

[features]
goals = true
"@ | Out-File -FilePath "$codexDir\config.toml" -Encoding utf8

@"
{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}
"@ | Out-File -FilePath "$codexDir\auth.json" -Encoding utf8

After configuration, restart Codex CLI or the Codex app client.

Migrate an Old OAuth Session (Optional)

If you previously logged in to Codex with OAuth, the old session may temporarily disappear after switching the provider from built-in openai to OpenAI. It is not deleted. After confirming that config.toml uses model_provider = "OpenAI", run the migration script. Preview first, then execute:

# Windows PowerShell
.\scripts\codex-migrate-provider.ps1 --dryrun
.\scripts\codex-migrate-provider.ps1

# macOS / Linux / WSL
scripts/codex-migrate-provider.sh --dryrun
scripts/codex-migrate-provider.sh

The script migrates old openai sessions to the current provider by default. Before writing changes, it asks you to type MIGRATE and backs up affected SQLite and session JSONL files. You can roll back from the backup directory. If the old session came from another custom provider, specify it with -From.

Verify Configuration

Start a simple task in Codex or VS Code:

Read the current project structure and summarize what this project may do. Do not modify files.

If Codex replies normally and the String AI console shows the corresponding usage record, the configuration is working.

开始前请确认你已经有可用的 String AI sk- 密钥。下面示例中的 YOUR_STRING_AI_API_KEY 请替换为你的个人密钥，不要把真实密钥提交到项目仓库或公开文档。

ClaudeCode的安装

Claude Code 可以通过官方原生安装器、Homebrew、WinGet 或 npm 安装。安装完成后，在终端运行 claude --version 或 claude doctor 检查 CLI 是否可用。

Windows CLI

推荐使用官方原生安装器。PowerShell 与 CMD 的命令不同，请按当前终端选择一种。

irm https://claude.ai/install.ps1 | iex

curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

winget install Anthropic.ClaudeCode
winget upgrade Anthropic.ClaudeCode

安装后打开新的终端执行：

claude --version
claude doctor

如果在 Windows 原生环境中使用 Claude Code，建议安装 Git for Windows；未安装时 Claude Code 会退回使用 PowerShell 执行 shell 工具。

MacOS CLI

macOS 可以使用官方原生安装器、Homebrew cask 或 npm 安装。

curl -fsSL https://claude.ai/install.sh | bash

brew install --cask claude-code
brew upgrade claude-code

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

npm install -g @anthropic-ai/claude-code
npm install -g @anthropic-ai/claude-code@latest

安装后执行：

claude --version
claude doctor

ClaudeCode的接入

String AI 作为 Claude Code 的网关接入时，核心是设置 ANTHROPIC_BASE_URL 和 ANTHROPIC_AUTH_TOKEN。ANTHROPIC_BASE_URL 使用站点根地址，不需要追加 /v1。

CC Switch接入

如果你用 CC Switch 管理 Claude Code 环境变量，可以新建或切换到 Claude Code 配置，并填入以下变量：

注意： YOUR_STRING_AI_API_KEY 指你在 String AI 后台自己创建的 API Key。创建 API Key 时，分组一定要选择 claude api 组，否则 Claude Code 无法按 Claude API 通道接入。

保存后从 CC Switch 启动 Claude Code，或重启终端后运行：

claude

进入 Claude Code 后运行 /status，确认能看到 Anthropic base URL 指向 https://www.string.ink，并且凭据来源显示为 ANTHROPIC_AUTH_TOKEN。

如果只是临时测试，也可以直接在当前终端设置环境变量。

export ANTHROPIC_BASE_URL="https://www.string.ink"
export ANTHROPIC_AUTH_TOKEN="YOUR_STRING_AI_API_KEY"
export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
export CLAUDE_CODE_ATTRIBUTION_HEADER=0
claude

set ANTHROPIC_BASE_URL=https://www.string.ink
set ANTHROPIC_AUTH_TOKEN=YOUR_STRING_AI_API_KEY
set CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
set CLAUDE_CODE_ATTRIBUTION_HEADER=0
claude

$env:ANTHROPIC_BASE_URL = "https://www.string.ink"
$env:ANTHROPIC_AUTH_TOKEN = "YOUR_STRING_AI_API_KEY"
$env:CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC = "1"
$env:CLAUDE_CODE_ATTRIBUTION_HEADER = "0"
claude

修改配置文件的方式

如果希望配置长期生效，建议写入用户级 Claude Code 设置文件：

{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}

mkdir -p ~/.claude
cat > ~/.claude/settings.json <<'JSON'
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}
JSON

$claudeDir = Join-Path $env:USERPROFILE ".claude"
New-Item -ItemType Directory -Force -Path $claudeDir | Out-Null
@'
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}
'@ | Set-Content -Path (Join-Path $claudeDir "settings.json") -Encoding UTF8

不要把真实密钥写入项目级 .claude/settings.json，因为它通常会被提交并分享给团队。若只想对当前项目本机生效，可以使用 .claude/settings.local.json，并确认它已被 .gitignore 忽略。

完成后重新打开终端，运行：

claude

在 Claude Code 里执行 /status，确认 Anthropic base URL 和 Auth token 来源正确。如果仍然走旧登录态，可以执行 /logout 后重新启动 Claude Code。

開始前請確認你已經有可用的 String AI sk- 金鑰。下面示例中的 YOUR_STRING_AI_API_KEY 請替換為你的個人金鑰，不要把真實金鑰提交到項目倉庫或公開文檔。

ClaudeCode的安裝

Claude Code 可以通過官方原生安裝器、Homebrew、WinGet 或 npm 安裝。安裝完成後，在終端運行 claude --version 或 claude doctor 檢查 CLI 是否可用。

Windows CLI

推薦使用官方原生安裝器。PowerShell 與 CMD 的命令不同，請按當前終端選擇一種。

irm https://claude.ai/install.ps1 | iex

curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

winget install Anthropic.ClaudeCode
winget upgrade Anthropic.ClaudeCode

安裝後打開新的終端執行：

claude --version
claude doctor

如果在 Windows 原生環境中使用 Claude Code，建議安裝 Git for Windows；未安裝時 Claude Code 會退回使用 PowerShell 執行 shell 工具。

MacOS CLI

macOS 可以使用官方原生安裝器、Homebrew cask 或 npm 安裝。

curl -fsSL https://claude.ai/install.sh | bash

brew install --cask claude-code
brew upgrade claude-code

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

npm install -g @anthropic-ai/claude-code
npm install -g @anthropic-ai/claude-code@latest

安裝後執行：

claude --version
claude doctor

ClaudeCode的接入

String AI 作為 Claude Code 的網關接入時，核心是設置 ANTHROPIC_BASE_URL 和 ANTHROPIC_AUTH_TOKEN。ANTHROPIC_BASE_URL 使用站點根地址，不需要追加 /v1。

CC Switch接入

如果你用 CC Switch 管理 Claude Code 環境變量，可以新建或切換到 Claude Code 設定，並填入以下變量：

注意： YOUR_STRING_AI_API_KEY 指你在 String AI 後台自己創建的 API Key。創建 API Key 時，分組一定要選擇 claude api 組，否則 Claude Code 無法按 Claude API 通道接入。

保存後從 CC Switch 啟動 Claude Code，或重啟終端後運行：

claude

進入 Claude Code 後運行 /status，確認能看到 Anthropic base URL 指向 https://www.string.ink，並且憑據來源顯示為 ANTHROPIC_AUTH_TOKEN。

如果只是臨時測試，也可以直接在當前終端設置環境變量。

export ANTHROPIC_BASE_URL="https://www.string.ink"
export ANTHROPIC_AUTH_TOKEN="YOUR_STRING_AI_API_KEY"
export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
export CLAUDE_CODE_ATTRIBUTION_HEADER=0
claude

set ANTHROPIC_BASE_URL=https://www.string.ink
set ANTHROPIC_AUTH_TOKEN=YOUR_STRING_AI_API_KEY
set CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
set CLAUDE_CODE_ATTRIBUTION_HEADER=0
claude

$env:ANTHROPIC_BASE_URL = "https://www.string.ink"
$env:ANTHROPIC_AUTH_TOKEN = "YOUR_STRING_AI_API_KEY"
$env:CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC = "1"
$env:CLAUDE_CODE_ATTRIBUTION_HEADER = "0"
claude

修改設定文件的方式

如果希望設定長期生效，建議寫入用戶級 Claude Code 設置文件：

{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}

mkdir -p ~/.claude
cat > ~/.claude/settings.json <<'JSON'
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}
JSON

$claudeDir = Join-Path $env:USERPROFILE ".claude"
New-Item -ItemType Directory -Force -Path $claudeDir | Out-Null
@'
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}
'@ | Set-Content -Path (Join-Path $claudeDir "settings.json") -Encoding UTF8

不要把真實金鑰寫入項目級 .claude/settings.json，因為它通常會被提交並分享給團隊。若只想對當前項目本機生效，可以使用 .claude/settings.local.json，並確認它已被 .gitignore 忽略。

完成後重新打開終端，運行：

claude

在 Claude Code 里執行 /status，確認 Anthropic base URL 和 Auth token 來源正確。如果仍然走舊登錄態，可以執行 /logout 後重新啟動 Claude Code。

शुरू करने से पहले, सुनिश्चित करें कि आपके पास उपयोग योग्य String AI sk- key है। नीचे दिए examples में YOUR_STRING_AI_API_KEY को अपनी key से बदलें, और real key को repository या public document में कभी commit न करें।

ClaudeCode स्थापना

Claude Code को आधिकारिक मूल इंस्टालर, Homebrew, WinGet या npm से स्थापित किया जा सकता है। स्थापना के बाद CLI की जाँच करने के लिए claude --version या claude doctor चलाएँ।

Windows CLI

आधिकारिक मूल इंस्टालर इस्तेमाल करें। PowerShell और CMD के कमांड अलग हैं।

irm https://claude.ai/install.ps1 | iex

curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

winget install Anthropic.ClaudeCode
winget upgrade Anthropic.ClaudeCode

फिर नया terminal खोलें और चलाएँ:

claude --version
claude doctor

Native Windows उपयोग के लिए Git for Windows अनुशंसित है। इसके बिना Claude Code शेल टूल के लिए PowerShell पर वापस आ जाता है।

macOS CLI

macOS पर native installer, Homebrew cask या npm से स्थापित करें।

curl -fsSL https://claude.ai/install.sh | bash

brew install --cask claude-code
brew upgrade claude-code

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

npm install -g @anthropic-ai/claude-code
npm install -g @anthropic-ai/claude-code@latest

स्थापना की जाँच करें:

claude --version
claude doctor

ClaudeCode कनेक्शन

String AI को Claude Code प्रवेशद्वार के रूप में इस्तेमाल करते समय ANTHROPIC_BASE_URL और ANTHROPIC_AUTH_TOKEN कॉन्फ़िगर करें। ANTHROPIC_BASE_URL के लिए साइट रूट इस्तेमाल करें; अंत में /v1 न जोड़ें।

CC Switch कनेक्शन

अगर आप Claude Code को CC Switch से प्रबंधित करते हैं, तो Claude Code प्रोफ़ाइल बनाएँ या उस पर स्विच करें, फिर ये एनवायरनमेंट वेरिएबल सेट करें:

नोट: YOUR_STRING_AI_API_KEY का मतलब String AI कंसोल में आपके द्वारा बनाया गया API Key है। API Key बनाते समय claude api समूह चुनना सुनिश्चित करें, नहीं तो Claude Code, Claude API चैनल से कनेक्ट नहीं कर पाएगा।

प्रोफ़ाइल सहेजें। फिर CC Switch से Claude Code शुरू करें, या टर्मिनल को दोबारा शुरू करके यह चलाएँ:

claude

Claude Code के अंदर /status चलाएँ। Anthropic base URL को https://www.string.ink पर इंगित करना चाहिए और प्रमाण-पत्र स्रोत ANTHROPIC_AUTH_TOKEN होना चाहिए।

त्वरित अस्थायी परीक्षण के लिए वर्तमान टर्मिनल सत्र में वेरिएबल सेट करें:

export ANTHROPIC_BASE_URL="https://www.string.ink"
export ANTHROPIC_AUTH_TOKEN="YOUR_STRING_AI_API_KEY"
export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
export CLAUDE_CODE_ATTRIBUTION_HEADER=0
claude

set ANTHROPIC_BASE_URL=https://www.string.ink
set ANTHROPIC_AUTH_TOKEN=YOUR_STRING_AI_API_KEY
set CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
set CLAUDE_CODE_ATTRIBUTION_HEADER=0
claude

$env:ANTHROPIC_BASE_URL = "https://www.string.ink"
$env:ANTHROPIC_AUTH_TOKEN = "YOUR_STRING_AI_API_KEY"
$env:CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC = "1"
$env:CLAUDE_CODE_ATTRIBUTION_HEADER = "0"
claude

कॉन्फ़िगरेशन फ़ाइल तरीका

स्थायी सेटअप के लिए वेरिएबल को उपयोगकर्ता-स्तरीय Claude Code सेटिंग फ़ाइल में लिखें:

{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}

mkdir -p ~/.claude
cat > ~/.claude/settings.json <<'JSON'
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}
JSON

$claudeDir = Join-Path $env:USERPROFILE ".claude"
New-Item -ItemType Directory -Force -Path $claudeDir | Out-Null
@'
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}
'@ | Set-Content -Path (Join-Path $claudeDir "settings.json") -Encoding UTF8

वास्तविक प्रमाण-पत्र को project-level .claude/settings.json में न डालें, क्योंकि यह file आम तौर पर कमिट होकर टीम के साथ साझा होती है। अगर configuration केवल एक local project पर लागू करनी है, तो .claude/settings.local.json इस्तेमाल करें और सुनिश्चित करें कि वह git अनदेखा है।

टर्मिनल को दोबारा शुरू करें और चलाएँ:

claude

Claude Code के अंदर /status चलाकर base URL और प्रमाण-पत्र स्रोत की पुष्टि करें। अगर Claude Code अभी भी पुराना login इस्तेमाल करता है, तो /logout चलाएँ और फिर दोबारा शुरू करें।

Before you start, make sure you have a usable String AI sk- key. Replace YOUR_STRING_AI_API_KEY with your own key in the examples below, and never commit a real key to a repository or public document.

ClaudeCode Installation

Claude Code can be installed with the official native installer, Homebrew, WinGet, or npm. After installation, run claude --version or claude doctor to verify the CLI.

Windows CLI

Use the official native installer. PowerShell and CMD use different commands.

irm https://claude.ai/install.ps1 | iex

curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

winget install Anthropic.ClaudeCode
winget upgrade Anthropic.ClaudeCode

Then open a new terminal and run:

claude --version
claude doctor

Git for Windows is recommended for native Windows use. Without it, Claude Code falls back to PowerShell for shell tools.

MacOS CLI

On macOS, install with the native installer, Homebrew cask, or npm.

curl -fsSL https://claude.ai/install.sh | bash

brew install --cask claude-code
brew upgrade claude-code

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

npm install -g @anthropic-ai/claude-code
npm install -g @anthropic-ai/claude-code@latest

Verify the install:

claude --version
claude doctor

ClaudeCode Connection

When using String AI as the Claude Code gateway, configure ANTHROPIC_BASE_URL and ANTHROPIC_AUTH_TOKEN. Use the site root for ANTHROPIC_BASE_URL; do not append /v1.

CC Switch Connection

If you manage Claude Code through CC Switch, create or switch to a Claude Code profile and set these environment variables:

Note: YOUR_STRING_AI_API_KEY means the API Key you create yourself in the String AI console. When creating the API Key, make sure to select the claude api group, otherwise Claude Code cannot connect through the Claude API channel.

Save the profile, then start Claude Code from CC Switch or restart your terminal and run:

claude

Inside Claude Code, run /status and confirm Anthropic base URL points to https://www.string.ink and the credential source is ANTHROPIC_AUTH_TOKEN.

For a quick temporary test, set the variables in the current terminal session:

export ANTHROPIC_BASE_URL="https://www.string.ink"
export ANTHROPIC_AUTH_TOKEN="YOUR_STRING_AI_API_KEY"
export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
export CLAUDE_CODE_ATTRIBUTION_HEADER=0
claude

set ANTHROPIC_BASE_URL=https://www.string.ink
set ANTHROPIC_AUTH_TOKEN=YOUR_STRING_AI_API_KEY
set CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
set CLAUDE_CODE_ATTRIBUTION_HEADER=0
claude

$env:ANTHROPIC_BASE_URL = "https://www.string.ink"
$env:ANTHROPIC_AUTH_TOKEN = "YOUR_STRING_AI_API_KEY"
$env:CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC = "1"
$env:CLAUDE_CODE_ATTRIBUTION_HEADER = "0"
claude

Configuration File Method

For a persistent setup, write the variables to the user-level Claude Code settings file:

{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}

mkdir -p ~/.claude
cat > ~/.claude/settings.json <<'JSON'
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}
JSON

$claudeDir = Join-Path $env:USERPROFILE ".claude"
New-Item -ItemType Directory -Force -Path $claudeDir | Out-Null
@'
{
  "env": {
    "ANTHROPIC_BASE_URL": "https://www.string.ink",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_STRING_AI_API_KEY",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "CLAUDE_CODE_ATTRIBUTION_HEADER": "0"
  }
}
'@ | Set-Content -Path (Join-Path $claudeDir "settings.json") -Encoding UTF8

Do not put real credentials in project-level .claude/settings.json, because that file is usually committed and shared with the team. If the configuration should apply only to one local project, use .claude/settings.local.json and make sure it is ignored by git.

Restart your terminal and run:

claude

Inside Claude Code, run /status to confirm the base URL and credential source. If Claude Code still uses an old login, run /logout and start it again.

开始前先确认：是否已经安装 Node.js？请执行 node --version 和 npm --version。若没有版本号，请先完成 安装 Node.js 运行环境。

CC Switch

CC Switch 是跨平台桌面应用，可在一个界面里管理 Claude Code、Claude Desktop、Codex、Gemini CLI、OpenCode、OpenClaw、Hermes 等工具的供应商、路由、用量、会话与技能。

安装

brew install --cask cc-switch
brew upgrade --cask cc-switch

方式 A：界面手动添加（推荐）

1. 打开 CC Switch，进入「通用提供商 / Universal Provider」标签页。
2. 点击「添加提供商」，填写：

• 名称：String AI
• Base URL：https://www.string.ink/v1
• API Key：你的 sk- 密钥
• 默认模型：gpt-5.5

1. 点击「测试连接 / Health Check」，返回成功即配置完成。
2. 保存后在工具（如 Claude Code）中切换到该提供商即可生效。

方式 B：预设代码

若维护 CC Switch 的 universalProviderPresets.ts，可加入预设条目：

{
  id: "stringai",
  name: "String AI",
  description: "String AI 中转服务 - Base URL: https://www.string.ink/v1",
  baseUrl: "https://www.string.ink/v1",
  models: ["gpt-5.5", "gpt-5.4", "gpt-5.4-mini"],
  defaultModel: "gpt-5.5",
  // 注意：gpt-5.5 不需要 reasoningEffort 参数
}

多数工具在切换供应商后需重启终端或对应 CLI 才会生效。切换后若 Codex 仍用旧配置，请关闭并重新打开终端、VS Code 或 Codex。

数据存储位置

開始前先確認：是否已經安裝 Node.js？請執行 node --version 和 npm --version。若沒有版本號，請先完成 安裝 Node.js 運行環境。

CC Switch

CC Switch 是跨平台桌面應用，可在一個界面里管理 Claude Code、Claude Desktop、Codex、Gemini CLI、OpenCode、OpenClaw、Hermes 等工具的供應商、路由、用量、會話與技能。

安裝

brew install --cask cc-switch
brew upgrade --cask cc-switch

方式 A：界面手動添加（推薦）

1. 打開 CC Switch，進入「通用提供商 / Universal Provider」標簽頁。
2. 點擊「添加提供商」，填寫：

• 名稱：String AI
• Base URL：https://www.string.ink/v1
• API Key：你的 sk- 金鑰
• 默認模型：gpt-5.5

1. 點擊「測試連接 / Health Check」，返回成功即設定完成。
2. 保存後在工具（如 Claude Code）中切換到該提供商即可生效。

方式 B：預設代碼

若維護 CC Switch 的 universalProviderPresets.ts，可加入預設條目：

{
  id: "stringai",
  name: "String AI",
  description: "String AI 中转服务 - Base URL: https://www.string.ink/v1",
  baseUrl: "https://www.string.ink/v1",
  models: ["gpt-5.5", "gpt-5.4", "gpt-5.4-mini"],
  defaultModel: "gpt-5.5",
  // 注意：gpt-5.5 不需要 reasoningEffort 参数
}

多數工具在切換供應商後需重啟終端或對應 CLI 才會生效。切換後若 Codex 仍用舊設定，請關閉並重新打開終端、VS Code 或 Codex。

資料存儲位置

शुरू करने से पहले: क्या आपने Node.js स्थापित कर लिया है? node --version और npm --version चलाएँ। अगर version numbers नहीं दिखते, तो पहले Node.js runtime स्थापित करें पूरा करें।

CC Switch

CC Switch एक क्रॉस-प्लेटफ़ॉर्म डेस्कटॉप ऐप है। इससे Claude Code, Claude Desktop, Codex, Gemini CLI, OpenCode, OpenClaw और Hermes जैसे टूल के प्रदाता, रूटिंग, उपयोग, सत्र और कौशल प्रबंधित किए जा सकते हैं।

स्थापना

brew install --cask cc-switch
brew upgrade --cask cc-switch

तरीका A: UI में प्रदाता जोड़ें (अनुशंसित)

1. CC Switch खोलें और Universal Provider टैब पर जाएँ।
2. Add Provider पर क्लिक करें और ये मान भरें:

• Name: String AI
• Base URL: https://www.string.ink/v1
• API Key: आपकी sk- कुंजी
• Default model: gpt-5.5

1. Health Check पर क्लिक करें। अगर जाँच सफल है, तो प्रदाता तैयार है।
2. सहेजें और अपने टूल, जैसे Claude Code, को इस प्रदाता पर स्विच करें।

तरीका B: प्रीसेट कोड

अगर आप CC Switch universalProviderPresets.ts अनुरक्षित करते हैं, तो यह प्रीसेट जोड़ें:

{
  id: "stringai",
  name: "String AI",
  description: "String AI relay service - Base URL: https://www.string.ink/v1",
  baseUrl: "https://www.string.ink/v1",
  models: ["gpt-5.5", "gpt-5.4", "gpt-5.4-mini"],
  defaultModel: "gpt-5.5",
  // Note: gpt-5.5 does not require a reasoningEffort parameter.
}

प्रदाता बदलने के बाद ज्यादातर टूल को टर्मिनल या CLI दोबारा शुरू करना पड़ता है। अगर Codex अभी भी पुरानी कॉन्फ़िगरेशन इस्तेमाल करता है, तो टर्मिनल, VS Code या Codex बंद करके दोबारा खोलें।

डेटा भंडारण स्थान

Before you start: have you installed Node.js? Run node --version and npm --version. If they do not print version numbers, finish Install the Node.js Runtime first.

CC Switch

CC Switch is a cross-platform desktop app for managing providers, routing, usage, sessions, and skills for tools such as Claude Code, Claude Desktop, Codex, Gemini CLI, OpenCode, OpenClaw, and Hermes.

Installation

brew install --cask cc-switch
brew upgrade --cask cc-switch

Method A: Add a Provider in the UI (Recommended)

1. Open CC Switch and go to the Universal Provider tab.
2. Click Add Provider and enter:

• Name: String AI
• Base URL: https://www.string.ink/v1
• API Key: your sk- key
• Default model: gpt-5.5

1. Click Health Check. If it succeeds, the provider is ready.
2. Save and switch your tool, such as Claude Code, to this provider.

Method B: Preset Code

If you maintain CC Switch universalProviderPresets.ts, add this preset:

{
  id: "stringai",
  name: "String AI",
  description: "String AI relay service - Base URL: https://www.string.ink/v1",
  baseUrl: "https://www.string.ink/v1",
  models: ["gpt-5.5", "gpt-5.4", "gpt-5.4-mini"],
  defaultModel: "gpt-5.5",
  // Note: gpt-5.5 does not require a reasoningEffort parameter.
}

Most tools need a terminal or CLI restart after switching providers. If Codex still uses the old configuration, close and reopen the terminal, VS Code, or Codex.

Data Storage Locations

开始前先确认：是否已经安装 Node.js？请执行 node --version 和 npm --version。若没有版本号，请先完成 安装 Node.js 运行环境。

OpenClaw

需要 Node.js 22.19+ 或 Node.js 24（推荐）。

安装

npm install -g openclaw@latest
npx openclaw --version

方式一：配置补丁（推荐）

创建配置文件 openclaw-stringai.json：

{
  "agents": {
    "defaults": {
      "model": { "primary": "stringai/gpt-5.5" },
      "models": {
        "stringai/gpt-5.5": { "alias": "String AI GPT-5.5" },
        "stringai/gpt-5.4": { "alias": "String AI GPT-5.4" },
        "stringai/gpt-5.4-mini": { "alias": "String AI GPT-5.4 Mini" }
      }
    }
  },
  "models": {
    "providers": {
      "stringai": {
        "baseUrl": "https://www.string.ink/v1",
        "apiKey": "${STRING_AI_API_KEY}",
        "api": "openai-completions",
        "timeoutSeconds": 120,
        "models": [
          { "id": "gpt-5.5", "name": "GPT-5.5", "contextWindow": 128000, "maxTokens": 16384 },
          { "id": "gpt-5.4", "name": "GPT-5.4", "contextWindow": 128000, "maxTokens": 16384 },
          { "id": "gpt-5.4-mini", "name": "GPT-5.4 Mini", "contextWindow": 128000, "maxTokens": 16384 }
        ]
      }
    }
  }
}

设置环境变量并应用配置：

# Windows PowerShell
$env:STRING_AI_API_KEY = "YOUR_API_KEY"
npx openclaw config patch --file openclaw-stringai.json --replace-path "models.providers.stringai.models"

# macOS / Linux / WSL
export STRING_AI_API_KEY="YOUR_API_KEY"
npx openclaw config patch --file openclaw-stringai.json --replace-path "models.providers.stringai.models"

如已有旧模型配置，需用 --replace-path 替换；遇到 "Refusing to replace" 错误说明需添加此参数。成功后显示：Applied 9 config update(s). Restart the gateway to apply.

验证与使用

npx openclaw config validate      # Config valid: ~/.openclaw/openclaw.json
npx openclaw models status        # 显示 String AI 模型列表与部分隐藏的 API Key

# 本地模式运行
npx openclaw agent --local --session-id my-session --message "你好" --model stringai/gpt-5.5
# 或启动 Gateway 后使用
npx openclaw onboard --install-daemon
npx openclaw agent --message "你好" --model stringai/gpt-5.5

环境变量持久化

# Windows PowerShell（管理员）
[Environment]::SetEnvironmentVariable("STRING_AI_API_KEY", "YOUR_API_KEY", "User")

# macOS / Linux
echo 'export STRING_AI_API_KEY="YOUR_API_KEY"' >> ~/.bashrc
source ~/.bashrc

開始前先確認：是否已經安裝 Node.js？請執行 node --version 和 npm --version。若沒有版本號，請先完成 安裝 Node.js 運行環境。

OpenClaw

需要 Node.js 22.19+ 或 Node.js 24（推薦）。

安裝

npm install -g openclaw@latest
npx openclaw --version

方式一：設定補丁（推薦）

創建設定文件 openclaw-stringai.json：

{
  "agents": {
    "defaults": {
      "model": { "primary": "stringai/gpt-5.5" },
      "models": {
        "stringai/gpt-5.5": { "alias": "String AI GPT-5.5" },
        "stringai/gpt-5.4": { "alias": "String AI GPT-5.4" },
        "stringai/gpt-5.4-mini": { "alias": "String AI GPT-5.4 Mini" }
      }
    }
  },
  "models": {
    "providers": {
      "stringai": {
        "baseUrl": "https://www.string.ink/v1",
        "apiKey": "${STRING_AI_API_KEY}",
        "api": "openai-completions",
        "timeoutSeconds": 120,
        "models": [
          { "id": "gpt-5.5", "name": "GPT-5.5", "contextWindow": 128000, "maxTokens": 16384 },
          { "id": "gpt-5.4", "name": "GPT-5.4", "contextWindow": 128000, "maxTokens": 16384 },
          { "id": "gpt-5.4-mini", "name": "GPT-5.4 Mini", "contextWindow": 128000, "maxTokens": 16384 }
        ]
      }
    }
  }
}

設置環境變量並應用設定：

# Windows PowerShell
$env:STRING_AI_API_KEY = "YOUR_API_KEY"
npx openclaw config patch --file openclaw-stringai.json --replace-path "models.providers.stringai.models"

# macOS / Linux / WSL
export STRING_AI_API_KEY="YOUR_API_KEY"
npx openclaw config patch --file openclaw-stringai.json --replace-path "models.providers.stringai.models"

如已有舊模型設定，需用 --replace-path 替換；遇到 "Refusing to replace" 錯誤說明需添加此參數。成功後顯示：Applied 9 config update(s). Restart the gateway to apply.

驗證與使用

npx openclaw config validate      # Config valid: ~/.openclaw/openclaw.json
npx openclaw models status        # 显示 String AI 模型列表与部分隐藏的 API Key

# 本地模式运行
npx openclaw agent --local --session-id my-session --message "你好" --model stringai/gpt-5.5
# 或启动 Gateway 后使用
npx openclaw onboard --install-daemon
npx openclaw agent --message "你好" --model stringai/gpt-5.5

環境變量持久化

# Windows PowerShell（管理员）
[Environment]::SetEnvironmentVariable("STRING_AI_API_KEY", "YOUR_API_KEY", "User")

# macOS / Linux
echo 'export STRING_AI_API_KEY="YOUR_API_KEY"' >> ~/.bashrc
source ~/.bashrc

शुरू करने से पहले: क्या आपने Node.js स्थापित कर लिया है? node --version और npm --version चलाएँ। अगर version numbers नहीं दिखते, तो पहले Node.js runtime स्थापित करें पूरा करें।

OpenClaw

Node.js 22.19+ या Node.js 24 (अनुशंसित) आवश्यक है।

स्थापना

npm install -g openclaw@latest
npx openclaw --version

विकल्प 1: कॉन्फ़िगरेशन पैच (अनुशंसित)

openclaw-stringai.json बनाएँ:

{
  "agents": {
    "defaults": {
      "model": { "primary": "stringai/gpt-5.5" },
      "models": {
        "stringai/gpt-5.5": { "alias": "String AI GPT-5.5" },
        "stringai/gpt-5.4": { "alias": "String AI GPT-5.4" },
        "stringai/gpt-5.4-mini": { "alias": "String AI GPT-5.4 Mini" }
      }
    }
  },
  "models": {
    "providers": {
      "stringai": {
        "baseUrl": "https://www.string.ink/v1",
        "apiKey": "${STRING_AI_API_KEY}",
        "api": "openai-completions",
        "timeoutSeconds": 120,
        "models": [
          { "id": "gpt-5.5", "name": "GPT-5.5", "contextWindow": 128000, "maxTokens": 16384 },
          { "id": "gpt-5.4", "name": "GPT-5.4", "contextWindow": 128000, "maxTokens": 16384 },
          { "id": "gpt-5.4-mini", "name": "GPT-5.4 Mini", "contextWindow": 128000, "maxTokens": 16384 }
        ]
      }
    }
  }
}

एनवायरनमेंट वेरिएबल सेट करें और कॉन्फ़िगरेशन लागू करें:

# Windows PowerShell
$env:STRING_AI_API_KEY = "YOUR_API_KEY"
npx openclaw config patch --file openclaw-stringai.json --replace-path "models.providers.stringai.models"

# macOS / Linux / WSL
export STRING_AI_API_KEY="YOUR_API_KEY"
npx openclaw config patch --file openclaw-stringai.json --replace-path "models.providers.stringai.models"

अगर पुरानी मॉडल कॉन्फ़िगरेशन पहले से मौजूद है, तो --replace-path इस्तेमाल करें। "Refusing to replace" त्रुटि का मतलब है कि यह पैरामीटर आवश्यक है। सफल होने पर आपको दिखना चाहिए: Applied 9 config update(s). Restart the gateway to apply.

जाँचें और इस्तेमाल करें

npx openclaw config validate      # कॉन्फ़िग मान्य: ~/.openclaw/openclaw.json
npx openclaw models status        # String AI मॉडल और आंशिक रूप से छिपी API Key दिखाता है

# स्थानीय मोड
npx openclaw agent --local --session-id my-session --message "Hello" --model stringai/gpt-5.5
# या पहले प्रवेशद्वार शुरू करें
npx openclaw onboard --install-daemon
npx openclaw agent --message "Hello" --model stringai/gpt-5.5

एनवायरनमेंट वेरिएबल स्थायी करें

# Windows PowerShell, as administrator
[Environment]::SetEnvironmentVariable("STRING_AI_API_KEY", "YOUR_API_KEY", "User")

# macOS / Linux
echo 'export STRING_AI_API_KEY="YOUR_API_KEY"' >> ~/.bashrc
source ~/.bashrc

Before you start: have you installed Node.js? Run node --version and npm --version. If they do not print version numbers, finish Install the Node.js Runtime first.

OpenClaw

Requires Node.js 22.19+ or Node.js 24, recommended.

Installation

npm install -g openclaw@latest
npx openclaw --version

Option 1: Configuration Patch (Recommended)

Create openclaw-stringai.json:

{
  "agents": {
    "defaults": {
      "model": { "primary": "stringai/gpt-5.5" },
      "models": {
        "stringai/gpt-5.5": { "alias": "String AI GPT-5.5" },
        "stringai/gpt-5.4": { "alias": "String AI GPT-5.4" },
        "stringai/gpt-5.4-mini": { "alias": "String AI GPT-5.4 Mini" }
      }
    }
  },
  "models": {
    "providers": {
      "stringai": {
        "baseUrl": "https://www.string.ink/v1",
        "apiKey": "${STRING_AI_API_KEY}",
        "api": "openai-completions",
        "timeoutSeconds": 120,
        "models": [
          { "id": "gpt-5.5", "name": "GPT-5.5", "contextWindow": 128000, "maxTokens": 16384 },
          { "id": "gpt-5.4", "name": "GPT-5.4", "contextWindow": 128000, "maxTokens": 16384 },
          { "id": "gpt-5.4-mini", "name": "GPT-5.4 Mini", "contextWindow": 128000, "maxTokens": 16384 }
        ]
      }
    }
  }
}

Set the environment variable and apply the configuration:

# Windows PowerShell
$env:STRING_AI_API_KEY = "YOUR_API_KEY"
npx openclaw config patch --file openclaw-stringai.json --replace-path "models.providers.stringai.models"

# macOS / Linux / WSL
export STRING_AI_API_KEY="YOUR_API_KEY"
npx openclaw config patch --file openclaw-stringai.json --replace-path "models.providers.stringai.models"

If old model configuration already exists, use --replace-path. A "Refusing to replace" error means this parameter is required. On success you should see: Applied 9 config update(s). Restart the gateway to apply.

Verify and Use

npx openclaw config validate      # Config valid: ~/.openclaw/openclaw.json
npx openclaw models status        # Shows String AI models and a partially hidden API Key

# Local mode
npx openclaw agent --local --session-id my-session --message "Hello" --model stringai/gpt-5.5
# Or start the gateway first
npx openclaw onboard --install-daemon
npx openclaw agent --message "Hello" --model stringai/gpt-5.5

Persist the Environment Variable

# Windows PowerShell, as administrator
[Environment]::SetEnvironmentVariable("STRING_AI_API_KEY", "YOUR_API_KEY", "User")

# macOS / Linux
echo 'export STRING_AI_API_KEY="YOUR_API_KEY"' >> ~/.bashrc
source ~/.bashrc

开始前先确认：是否已经安装 Node.js？请执行 node --version 和 npm --version。若没有版本号，请先完成 安装 Node.js 运行环境。

Hermes Agent

安装（Windows PowerShell）

iex (irm https://hermes-agent.nousresearch.com/install.ps1)

配置 String AI

安装时选择 Full setup（选项 2），然后依次设置：

配置完成后运行 hermes 验证。

開始前先確認：是否已經安裝 Node.js？請執行 node --version 和 npm --version。若沒有版本號，請先完成 安裝 Node.js 運行環境。

Hermes Agent

安裝（Windows PowerShell）

iex (irm https://hermes-agent.nousresearch.com/install.ps1)

設定 String AI

安裝時選擇 Full setup（選項 2），然後依次設置：

設定完成後運行 hermes 驗證。

शुरू करने से पहले: क्या आपने Node.js स्थापित कर लिया है? node --version और npm --version चलाएँ। अगर version numbers नहीं दिखते, तो पहले Node.js runtime स्थापित करें पूरा करें।

Hermes Agent

स्थापना (Windows PowerShell)

iex (irm https://hermes-agent.nousresearch.com/install.ps1)

String AI कॉन्फ़िगर करें

स्थापना के दौरान Full setup (विकल्प 2) चुनें, फिर ये मान सेट करें:

सेटअप पूरा होने के बाद सत्यापन के लिए hermes चलाएँ।

Before you start: have you installed Node.js? Run node --version and npm --version. If they do not print version numbers, finish Install the Node.js Runtime first.

Hermes Agent

Installation (Windows PowerShell)

iex (irm https://hermes-agent.nousresearch.com/install.ps1)

Configure String AI

During installation, choose Full setup (option 2), then set the following:

After setup, run hermes to verify.

开始前先确认：是否已经安装 Node.js？请执行 node --version 和 npm --version。若没有版本号，请先完成 安装 Node.js 运行环境。

Cursor

Cursor 是 AI 驱动的代码编辑器。配置步骤：

1. 点击左下角设置图标（齿轮），在左侧菜单点击 Models。
2. 展开 API Keys 部分，在 OpenAI API Key 处填入你的 String AI API Key。
3. 打开 Override OpenAI Base URL 开关（变为绿色），在下方输入框填入 https://www.string.ink/v1。

配置完成后即可在 Cursor 中使用 String AI 的模型。

開始前先確認：是否已經安裝 Node.js？請執行 node --version 和 npm --version。若沒有版本號，請先完成 安裝 Node.js 運行環境。

Cursor

Cursor 是 AI 驅動的代碼編輯器。設定步驟：

1. 點擊左下角設置圖標（齿輪），在左側菜單點擊 Models。
2. 展開 API Keys 部分，在 OpenAI API Key 處填入你的 String AI API Key。
3. 打開 Override OpenAI Base URL 開關（變為綠色），在下方輸入框填入 https://www.string.ink/v1。

設定完成後即可在 Cursor 中使用 String AI 的模型。

शुरू करने से पहले: क्या आपने Node.js स्थापित कर लिया है? node --version और npm --version चलाएँ। अगर version numbers नहीं दिखते, तो पहले Node.js runtime स्थापित करें पूरा करें।

Cursor

Cursor एक AI-सहायित कोड एडिटर है। इसे इस तरह कॉन्फ़िगर करें:

1. नीचे बाएँ कोने में सेटिंग आइकन पर क्लिक करें, फिर साइडबार से Models खोलें।
2. API Keys खोलें और OpenAI API Key फ़ील्ड में अपना String AI API Key डालें।
3. Override OpenAI Base URL चालू करें, फिर https://www.string.ink/v1 डालें।

कॉन्फ़िगरेशन पूरी होने के बाद आप Cursor में String AI मॉडल इस्तेमाल कर सकते हैं।

Before you start: have you installed Node.js? Run node --version and npm --version. If they do not print version numbers, finish Install the Node.js Runtime first.

Cursor

Cursor is an AI-powered code editor. Configure it as follows:

1. Click the settings icon in the bottom-left corner, then open Models from the sidebar.
2. Expand API Keys and enter your String AI API Key in the OpenAI API Key field.
3. Turn on Override OpenAI Base URL, then enter https://www.string.ink/v1.

After configuration, you can use String AI models in Cursor.

开始前先确认：是否已经安装 Node.js？请执行 node --version 和 npm --version。若没有版本号，请先完成 安装 Node.js 运行环境。

WorkBuddy

1. 打开 WorkBuddy，在主页点击对话框的 [Auto] 按钮，进入「选择模型」页面，点击「自定义模型」。
2. 在「添加模型」窗口中（仅支持 OpenAI 兼容协议 API），点击「提供商」下拉框，在最底部「其他」分组下选择「自定义 / Custom」。
3. 按下表填写接入信息：

高级配置（可选）：按所选模型能力勾选「工具调用」（function calling）、「图片输入」（多模态视觉）、「思考模式」（推理/thinking）；「自定义协议」一般不勾选。输入/输出上下文长度可保持「使用提供商默认值」或按需选择。点击「保存」完成添加，返回主界面在模型选择器中即可选用。

開始前先確認：是否已經安裝 Node.js？請執行 node --version 和 npm --version。若沒有版本號，請先完成 安裝 Node.js 運行環境。

WorkBuddy

1. 打開 WorkBuddy，在主頁點擊對話框的 [Auto] 按钮，進入「選擇模型」頁面，點擊「自定義模型」。
2. 在「添加模型」窗口中（僅支持 OpenAI 兼容協議 API），點擊「提供商」下拉框，在最底部「其他」分組下選擇「自定義 / Custom」。
3. 按下表填寫接入資訊：

高級設定（可選）：按所選模型能力勾選「工具調用」（function calling）、「圖片輸入」（多模態視覺）、「思考模式」（推理/thinking）；「自定義協議」一般不勾選。輸入/輸出上下文長度可保持「使用提供商默認值」或按需選擇。點擊「保存」完成添加，返回主界面在模型選擇器中即可選用。

शुरू करने से पहले: क्या आपने Node.js स्थापित कर लिया है? node --version और npm --version चलाएँ। अगर version numbers नहीं दिखते, तो पहले Node.js runtime स्थापित करें पूरा करें।

WorkBuddy

1. WorkBuddy खोलें। मुख पृष्ठ पर चैट बॉक्स में [Auto] बटन पर क्लिक करें, मॉडल चयन पृष्ठ खोलें, फिर कस्टम मॉडल पर क्लिक करें।
2. मॉडल जोड़ें में OpenAI-संगत API समर्थित हैं। प्रदाता ड्रॉपडाउन खोलें और अन्य समूह के अंतर्गत कस्टम चुनें।
3. पहुँच जानकारी भरें:

उन्नत सेटिंग, वैकल्पिक: चुने गए मॉडल की क्षमता के अनुसार function calling, image input और thinking / reasoning सक्षम करें। कस्टम प्रोटोकॉल आम तौर पर जरूरी नहीं होता। इनपुट और आउटपुट संदर्भ लंबाई को प्रदाता डिफ़ॉल्ट पर रखें या जरूरत के अनुसार समायोजित करें। सहेजें पर क्लिक करें, फिर मुख्य मॉडल चयनकर्ता में मॉडल चुनें।

Before you start: have you installed Node.js? Run node --version and npm --version. If they do not print version numbers, finish Install the Node.js Runtime first.

WorkBuddy

1. Open WorkBuddy. On the home page, click the [Auto] button in the chat box, open the model selection page, and click Custom Model.
2. In Add Model, which supports OpenAI-compatible APIs, open the Provider dropdown and choose Custom under the Other group.
3. Fill in the access information:

Advanced settings, optional: enable function calling, image input, and thinking / reasoning according to the selected model's capability. Custom protocol is usually not needed. Keep input and output context length on provider defaults or adjust as needed. Click Save, then choose the model in the main model selector.

开始前先确认：是否已经安装 Node.js？请执行 node --version 和 npm --version。若没有版本号，请先完成 安装 Node.js 运行环境。

Dify

认准入口：「模型供应商」用来接入模型（本教程使用）；「API 扩展」用于挂载外部 HTTP 服务做内容审查等中间件回调，不是用来接模型的，请勿在此填写 String AI 地址。

配置步骤

进入 Dify → 右上角头像 → 设置 → 模型供应商，搜索 OpenAI-API-compatible，点击「添加模型」，按下表填写：

Vision / Function calling / Stream 按模型实际能力开关，不确定先保持默认，最后点击「添加」。

開始前先確認：是否已經安裝 Node.js？請執行 node --version 和 npm --version。若沒有版本號，請先完成 安裝 Node.js 運行環境。

Dify

認準入口：「模型供應商」用來接入模型（本教程使用）；「API 擴展」用於掛載外部 HTTP 服務做內容審查等中間件回調，不是用來接模型的，請勿在此填寫 String AI 地址。

設定步驟

進入 Dify → 右上角頭像 → 設置 → 模型供應商，搜索 OpenAI-API-compatible，點擊「添加模型」，按下表填寫：

Vision / Function calling / Stream 按模型實際能力開關，不確定先保持默認，最後點擊「添加」。

शुरू करने से पहले: क्या आपने Node.js स्थापित कर लिया है? node --version और npm --version चलाएँ। अगर version numbers नहीं दिखते, तो पहले Node.js runtime स्थापित करें पूरा करें।

Dify

सही प्रवेश इस्तेमाल करें: मॉडल प्रदाता मॉडल पहुँच के लिए है और इस गाइड में वही इस्तेमाल होता है। API Extension बाहरी HTTP मिडलवेयर कॉलबैक, जैसे सामग्री समीक्षा, के लिए है। यह मॉडल पहुँच के लिए नहीं है। वहाँ String AI पता न डालें।

कॉन्फ़िगरेशन चरण

Dify में जाएँ -> ऊपर दाएँ कोने में अवतार -> सेटिंग -> मॉडल प्रदाता। OpenAI-API-compatible खोजें, मॉडल जोड़ें पर क्लिक करें, और ये मान भरें:

वास्तविक model capability के अनुसार Vision, Function calling और Stream सक्षम करें। अगर निश्चित न हों, पहले डिफ़ॉल्ट रखें, फिर जोड़ें पर क्लिक करें।

Before you start: have you installed Node.js? Run node --version and npm --version. If they do not print version numbers, finish Install the Node.js Runtime first.

Dify

Use the correct entry: Model Provider is for model access and is used in this guide. API Extension is for external HTTP middleware callbacks such as content review. It is not for model access. Do not enter the String AI address there.

Configuration Steps

Go to Dify -> avatar in the top-right corner -> Settings -> Model Provider. Search for OpenAI-API-compatible, click Add Model, and fill in:

Enable Vision, Function calling, and Stream based on the actual model capability. If unsure, keep defaults first, then click Add.

开始前先确认：是否已经安装 Node.js？请执行 node --version 和 npm --version。若没有版本号，请先完成 安装 Node.js 运行环境。

One API

启动 One API

git clone https://github.com/songquanpeng/one-api.git
cd one-api
go build -o one-api
./one-api

访问 http://localhost:3000，默认用户名/密码 admin / 123456。

添加渠道

进入「渠道」→「添加渠道」，选择 Proxy 类型：

然后在「模型」管理中为 gpt-5.5、gpt-5.4、gpt-5.4-mini 创建映射。

测试

API_KEY="sk-one-api-key"
curl https://localhost:3000/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "gpt-5.5", "messages": [{"role": "user", "content": "Hello"}]}'

開始前先確認：是否已經安裝 Node.js？請執行 node --version 和 npm --version。若沒有版本號，請先完成 安裝 Node.js 運行環境。

One API

啟動 One API

git clone https://github.com/songquanpeng/one-api.git
cd one-api
go build -o one-api
./one-api

訪問 http://localhost:3000，默認用戶名/密碼 admin / 123456。

添加渠道

進入「渠道」→「添加渠道」，選擇 Proxy 類型：

然後在「模型」管理中為 gpt-5.5、gpt-5.4、gpt-5.4-mini 創建映射。

測試

API_KEY="sk-one-api-key"
curl https://localhost:3000/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "gpt-5.5", "messages": [{"role": "user", "content": "Hello"}]}'

शुरू करने से पहले: क्या आपने Node.js स्थापित कर लिया है? node --version और npm --version चलाएँ। अगर version numbers नहीं दिखते, तो पहले Node.js runtime स्थापित करें पूरा करें।

One API

One API शुरू करें

git clone https://github.com/songquanpeng/one-api.git
cd one-api
go build -o one-api
./one-api

http://localhost:3000 खोलें। डिफ़ॉल्ट उपयोगकर्ता नाम और पासवर्ड admin / 123456 हैं।

चैनल जोड़ें

Channels -> Add Channel पर जाएँ और Proxy चुनें:

इसके बाद मॉडल प्रबंधन में gpt-5.5, gpt-5.4 और gpt-5.4-mini के लिए मॉडल मैपिंग बनाएँ।

परीक्षण

API_KEY="sk-one-api-key"
curl https://localhost:3000/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "gpt-5.5", "messages": [{"role": "user", "content": "Hello"}]}'

Before you start: have you installed Node.js? Run node --version and npm --version. If they do not print version numbers, finish Install the Node.js Runtime first.

One API

Start One API

git clone https://github.com/songquanpeng/one-api.git
cd one-api
go build -o one-api
./one-api

Open http://localhost:3000. The default username and password are admin / 123456.

Add a Channel

Go to Channels -> Add Channel and choose Proxy:

Then create model mappings for gpt-5.5, gpt-5.4, and gpt-5.4-mini in model management.

Test

API_KEY="sk-one-api-key"
curl https://localhost:3000/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "gpt-5.5", "messages": [{"role": "user", "content": "Hello"}]}'

故障排查速查

本指南适用于 String AI API 付费用户。如仅使用网页聊天，无需 API Key，直接通过 Webchat 使用即可。

故障排查速查

本指南適用於 String AI API 付費用戶。如僅使用網頁聊天，無需 API Key，直接通過 Webchat 使用即可。

त्वरित समस्या-समाधान संदर्भ

यह गाइड String AI API भुगतान उपयोगकर्ताओं के लिए है। अगर आप सिर्फ web chat इस्तेमाल करते हैं, तो आपको API Key की जरूरत नहीं है। सीधे Webchat इस्तेमाल करें।

Troubleshooting Quick Reference

This guide is for paid String AI API users. If you only use web chat, you do not need an API Key. Use Webchat directly.

模型说明

String AI 提供对话、图像、转写和代码审查等不同能力模型。接入前建议先确认你的账号可用模型，再把模型 ID 填到脚本或第三方工具中。

对话模型

• gpt-5.5：最新旗舰模型，推荐作为默认对话模型。
• gpt-5.4：上一代旗舰模型，适合稳定文本生成、问答和工具调用场景。
• gpt-5.4-mini：轻量快速版本，适合验证链路、低延迟脚本和成本敏感任务。

代码与自动化

• codex-auto-review：代码自动审查模型，适合接入代码审查流程。

图像能力

• gpt-image-1s：图像生成模型。
• gpt-image-1.5：图像生成模型。
• gpt-image-2：推荐图片生成与图片编辑模型。

语音转写

• gpt-4o-transcribe：语音转文本模型，适合音频转写场景。

查询可用模型

不同账号可能拥有不同模型权限。你可以通过模型列表接口确认当前 API Key 可访问的模型：

curl https://www.string.ink/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

如果接口返回 object: "list" 和 data 数组，说明 API Key、Base URL 与网络连通性基本正常。

模型說明

String AI 提供對話、圖像、轉寫和代碼審查等不同能力模型。接入前建議先確認你的帳號可用模型，再把模型 ID 填到腳本或第三方工具中。

對話模型

• gpt-5.5：最新旗舰模型，推薦作為默認對話模型。
• gpt-5.4：上一代旗舰模型，適合穩定文本生成、問答和工具調用場景。
• gpt-5.4-mini：輕量快速版本，適合驗證鏈路、低延遲腳本和成本敏感任務。

代碼與自動化

• codex-auto-review：代碼自動審查模型，適合接入代碼審查流程。

圖像能力

• gpt-image-1s：圖像生成模型。
• gpt-image-1.5：圖像生成模型。
• gpt-image-2：推薦圖片生成與圖片編輯模型。

語音轉寫

• gpt-4o-transcribe：語音轉文本模型，適合音訊轉寫場景。

查詢可用模型

不同帳號可能擁有不同模型權限。你可以通過模型列表介面確認當前 API Key 可訪問的模型：

curl https://www.string.ink/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

如果介面返回 object: "list" 和 data 數組，說明 API Key、Base URL 與網絡連通性基本正常。

मॉडल अवलोकन

String AI बातचीत, चित्र निर्माण, ध्वनि-से-पाठ, कोड समीक्षा और स्वचालन के लिए मॉडल उपलब्ध कराता है। एकीकरण से पहले यह पुष्टि करें कि आपका खाता किन मॉडलों तक पहुँच रखता है, फिर स्क्रिप्ट या तृतीय-पक्ष टूल में model ID इस्तेमाल करें।

बातचीत मॉडल

• gpt-5.5: नवीनतम प्रमुख मॉडल, डिफ़ॉल्ट बातचीत मॉडल के रूप में अनुशंसित।
• gpt-5.4: स्थिर पाठ निर्माण, प्रश्नोत्तर और उपकरण-कॉल कार्यप्रवाह के लिए पिछली पीढ़ी का प्रमुख मॉडल।
• gpt-5.4-mini: लिंक परीक्षण, कम विलंबता वाली स्क्रिप्ट और लागत-संवेदनशील कामों के लिए हल्का और तेज़ मॉडल।

कोडिंग और स्वचालन

• codex-auto-review: कोड समीक्षा कार्यप्रवाह के लिए स्वचालित कोड समीक्षा मॉडल।

चित्र क्षमताएँ

• gpt-image-1s: चित्र निर्माण मॉडल।
• gpt-image-1.5: चित्र निर्माण मॉडल।
• gpt-image-2: चित्र निर्माण और चित्र संपादन के लिए अनुशंसित मॉडल।

ध्वनि लिप्यंतरण

• gpt-4o-transcribe: ऑडियो प्रतिलेखन परिदृश्यों के लिए वाक्-से-पाठ मॉडल।

उपलब्ध मॉडल देखें

अलग-अलग खातों की मॉडल अनुमतियाँ अलग हो सकती हैं। आपका API Key किन मॉडलों तक पहुँच रखता है, यह पुष्टि करने के लिए मॉडल सूची एंडपॉइंट इस्तेमाल करें:

curl https://www.string.ink/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

अगर API object: "list" और data array लौटाता है, तो आपका API Key, Base URL और नेटवर्क कनेक्शन मूल रूप से काम कर रहे हैं।

Model Overview

String AI provides models for conversation, image generation, transcription, code review, and automation. Before integrating, confirm which models your account can access, then use the model ID in scripts or third-party tools.

Conversation Models

• gpt-5.5: The latest flagship model, recommended as the default conversation model.
• gpt-5.4: Previous-generation flagship model for stable text generation, Q&A, and tool-calling workflows.
• gpt-5.4-mini: Lightweight and fast model for link testing, low-latency scripts, and cost-sensitive tasks.

Coding and Automation

• codex-auto-review: Automated code review model for code review workflows.

Image Capabilities

• gpt-image-1s: Image generation model.
• gpt-image-1.5: Image generation model.
• gpt-image-2: Recommended model for image generation and image editing.

Speech Transcription

• gpt-4o-transcribe: Speech-to-text model for audio transcription scenarios.

Query Available Models

Different accounts may have different model permissions. Use the model list endpoint to confirm which models your API Key can access:

curl https://www.string.ink/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

If the API returns object: "list" and a data array, your API Key, Base URL, and network connection are basically working.