API 密钥管理
您需要一个 API 密钥来验证对 Mechanix API 的请求。要获取您的 API 密钥,请导航至 仪表盘 并复制以 mec-
开头的值。
将 API 密钥存储在安全的地方,例如 .env
文件中。将 API 密钥导出为环境变量后,即可在代码中使用:
使用 export
命令设置 MECHANIX_API_KEY
环境变量:
export MECHANIX_API_KEY="your_api_key_here"
使用 export
命令设置 MECHANIX_API_KEY
环境变量:
export MECHANIX_API_KEY="your_api_key_here"
使用 PowerShell 设置 MECHANIX_API_KEY
环境变量:
$env:MECHANIX_API_KEY="your_api_key_here"
第一个 API 请求
导出 API 密钥后,您可以直接使用 REST API 或 Python SDK 发起您的第一个请求。
以下示例演示如何使用 Web Search
工具。
使用 pip
安装 Mechanix Python SDK:
pip install --pre mechanix
# 注意:--pre 安装预发布版本。请确保版本至少为 0.1.0a6。
发起您的第一个 API 请求:
from mechanix import Mechanix
# 自动检索 MECHANIX_API_KEY 环境变量。
# 或者,您可以使用 `api_key` 参数显式传递它。
mec = Mechanix()
# 执行网页搜索并请求生成 LLM 回答
response = mec.tools.search_web(query="What is OpenAI's 'o3' model?", llm_answer=True)
print(response.data.llm.answer)
# 示例输出(可能有所不同):
# OpenAI's 'o3' model is a large language model designed for complex tasks...
使用 pip
安装 Mechanix Python SDK:
pip install --pre mechanix
# 注意:--pre 安装预发布版本。请确保版本至少为 0.1.0a6。
发起您的第一个 API 请求:
from mechanix import Mechanix
# 自动检索 MECHANIX_API_KEY 环境变量。
# 或者,您可以使用 `api_key` 参数显式传递它。
mec = Mechanix()
# 执行网页搜索并请求生成 LLM 回答
response = mec.tools.search_web(query="What is OpenAI's 'o3' model?", llm_answer=True)
print(response.data.llm.answer)
# 示例输出(可能有所不同):
# OpenAI's 'o3' model is a large language model designed for complex tasks...
以下是使用 cURL
发起请求的方法:
curl -X POST "https://api.mechanix.tools/v1/tools/search_web" \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_MECHANIX_API_KEY" \
-d '{"query": "What is OpenAI'\''s '\''o3'\'' model?", "llm_answer": true}'
示例输出(可能有所不同):
{
"data": {
"results": [
...
]
"llm": {
"answer": "OpenAI's 'o3' model is a large language model designed for complex tasks..."
}
}
}
下一步
您已经成功发起了第一个 Mechanix API 请求!🎉
探索以下资源以继续学习: