> For the complete documentation index, see [llms.txt](https://minara.ai/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://minara.ai/docs/minara-handbook/zh/jiao-yi/agent-api/api-key.md). # API 密钥 API 密钥方法适用于 **专业版** 和 **合作伙伴** 订阅计划用户。请从你的 Minara 个人资料中生成密钥，并将其包含在 `Authorization` 请求头中。 *** ## 要求 Minara Agent API 仅对 Pro 和 Partner 计划订阅者开放。如果你使用的是免费计划，请前往 **API** 选项卡查看升级提示。 如果你降级订阅，所有活跃的 API 密钥都会自动暂停，并在你续订后恢复。 *** ## 创建 API 密钥 1. 前往你的 **账户资料** 在 [minara.ai](https://minara.ai). 2. 选择 **API 密钥** 左侧菜单中的选项卡，然后点击 **创建**.
API Key tab in Minara account profile showing Create button
3. 输入名称和描述以标识该密钥的用途。
Create API key dialog with name and description fields
4. 创建后，你的 API 密钥将会显示。请复制并安全保存——它不会再次显示。
Newly created API key displayed for copying
*** ## 管理 API 密钥 | 操作 | 详情 | | -------- | ---------------------------------- | | **查看密钥** | 密钥列表中仅显示最后 4 个字符。点击可显示完整密钥。 | | **密钥上限** | 每个 Pro/Partner 账户最多可创建 5 个 API 密钥。 | | **删除密钥** | 需要 2FA 确认。删除后不可恢复。 | *** ## 身份验证 请将你的 API 密钥包含在每个请求的 `Authorization` 请求头中： ``` Authorization: Bearer ``` **示例：** ```bash curl -H "Authorization: Bearer sk-minara-xxxxxxxx" \\ https://api.minara.ai/v1/developer/chat ``` {% hint style="warning" %} 请像对待密码一样对待你的 API 密钥。切勿将其暴露在客户端代码或公开仓库中。 {% endhint %} *** ## 计费 所有 API 调用都会消耗你 Minara 账户中的 **积分** 。如果积分用完，API 请求将暂停，直到补充为止。 *** ## API 参考 基础 URL： `https://api.minara.ai` ### 聊天 **`POST /v1/developer/chat`** ## Developer Chat > Developer chat endpoint supporting both streaming and non-streaming response modes. ```json {"openapi":"3.0.0","info":{"title":"Minara Agent API","version":"1.0"},"servers":[{"url":"https://api-developer.minara.ai"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API-KEY","description":"Format: Authorization: Bearer "}},"schemas":{"ChatRequest":{"type":"object","required":["mode","stream","message"],"properties":{"mode":{"type":"string","enum":["fast","expert"],"description":"Required. Model mode: 'fast' for quick responses, 'expert' for in-depth analysis."},"stream":{"type":"boolean","description":"Required. Set to true for streaming (SSE), false for standard JSON response."},"message":{"$ref":"#/components/schemas/Message"}}},"Message":{"type":"object","required":["role","content"],"properties":{"role":{"type":"string","enum":["user"],"description":"Required. Message sender role, must be 'user'."},"content":{"type":"string","description":"Required. The user's query content."}}},"ChatResponse":{"type":"object","properties":{"chatId":{"type":"string","description":"Unique conversation ID."},"messageId":{"type":"string","description":"Unique message ID for this response."},"content":{"type":"string","description":"The AI-generated response content."},"usage":{"type":"object","description":"Usage statistics for the request."}}}}},"paths":{"/v1/developer/chat":{"post":{"summary":"Developer Chat","description":"Developer chat endpoint supporting both streaming and non-streaming response modes.","operationId":"developerChat","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatResponse"}},"text/event-stream":{"schema":{"type":"string","description":"Server-Sent Events (SSE) stream. Each event line starts with `data:`.\nThe final message is formed by concatenating chunk/delta content in order.\n"}}}},"401":{"description":"Unauthorized - Invalid or missing API key"}}}}}} ``` | 参数 | 类型 | 必需 | 描述 | | ----------------- | --- | -- | ------------------------------------- | | `mode` | 字符串 | 是 | `快速` 用于快速响应， `专家` 用于深入分析 | | `stream` | 布尔值 | 是 | `true` 用于 SSE 流式传输， `false` 用于标准 JSON | | `message.role` | 字符串 | 是 | 必须为 `user` | | `message.content` | 字符串 | 是 | 查询内容 | **示例：** ```bash curl -X POST https://api.minara.ai/v1/developer/chat \\ -H "Authorization: Bearer " \\ -H "Content-Type: application/json" \\ -d '{ "mode": "快速", "stream": false, "message": { "role": "user", "content": "分析 SOL 最近的价格走势。" } }' ``` *** ### 代币交换交易意图 **`POST /v1/developer/intent-to-swap-tx`** ## Intent to Swap Transaction > Convert natural language trading intent into an executable swap transaction payload. Compatible with OKX DEX by default. ```json {"openapi":"3.0.0","info":{"title":"Minara Agent API","version":"1.0"},"servers":[{"url":"https://api-developer.minara.ai"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API-KEY","description":"Format: Authorization: Bearer "}},"schemas":{"IntentToSwapRequest":{"type":"object","required":["intent","walletAddress"],"properties":{"intent":{"type":"string","description":"Required. Natural language swap intent (e.g., 'swap 0.1 ETH to USDC')."},"walletAddress":{"type":"string","description":"Required. User wallet address (0x...)."},"chain":{"type":"string","description":"Optional. Chain name (e.g., 'base', 'ethereum', 'bsc', 'arbitrum', 'optimism')."}}},"SwapTransactionResponse":{"type":"object","properties":{"intent":{"type":"object","description":"Parsed user intent","properties":{"chain":{"type":"string","description":"Chain name (e.g., 'base')."},"inputTokenAddress":{"type":"string","nullable":true,"description":"Input token contract address (null for native token)."},"inputTokenSymbol":{"type":"string","description":"Input token symbol (e.g., 'ETH')."},"outputTokenAddress":{"type":"string","description":"Output token contract address."},"outputTokenSymbol":{"type":"string","description":"Output token symbol (e.g., 'USDC')."},"amount":{"type":"string","description":"Token amount in wei/smallest unit."},"userWalletAddress":{"type":"string","description":"User's wallet address."}}},"quote":{"type":"object","description":"Swap quote and pricing information","properties":{"fromTokenAmount":{"type":"string","description":"Input token amount in smallest unit."},"toTokenAmount":{"type":"string","description":"Expected output token amount in smallest unit."},"estimatedGas":{"type":"string","description":"Estimated gas cost for the transaction."},"priceImpact":{"type":"string","description":"Price impact percentage."},"tradeFee":{"type":"string","description":"Trading fee amount."}}},"inputToken":{"type":"object","description":"Input token details","properties":{"address":{"type":"string","description":"Token contract address."},"symbol":{"type":"string","description":"Token symbol."},"decimals":{"type":"string","description":"Token decimals."},"unitPrice":{"type":"string","description":"Token unit price in USD."}}},"outputToken":{"type":"object","description":"Output token details","properties":{"address":{"type":"string","description":"Token contract address."},"symbol":{"type":"string","description":"Token symbol."},"decimals":{"type":"string","description":"Token decimals."},"unitPrice":{"type":"string","description":"Token unit price in USD."}}},"unsignedTx":{"type":"object","description":"Unsigned transaction ready to be signed and broadcasted","properties":{"chainType":{"type":"string","description":"Chain type (e.g., 'evm')."},"from":{"type":"string","description":"Sender address."},"to":{"type":"string","description":"Contract address to call."},"data":{"type":"string","description":"Encoded transaction data."},"value":{"type":"string","description":"Native token value to send (in wei)."},"gas":{"type":"string","description":"Gas limit."},"gasPrice":{"type":"string","description":"Gas price (legacy)."},"maxPriorityFeePerGas":{"type":"string","description":"Max priority fee per gas (EIP-1559)."}}},"approval":{"type":"object","description":"Token approval information (required for ERC20 token swaps)","properties":{"isRequired":{"type":"boolean","description":"Whether token approval is required before swap."},"tokenAddress":{"type":"string","description":"Token contract address that needs approval."},"spenderAddress":{"type":"string","description":"Spender address (DEX router) that needs approval."},"requiredAmount":{"type":"string","description":"Minimum token amount that needs to be approved."},"approveAmount":{"type":"string","description":"Recommended approval amount."},"currentAllowance":{"type":"string","description":"Current approved allowance for the spender."},"message":{"type":"string","description":"Human-readable approval status message."}}}}}}},"paths":{"/v1/developer/intent-to-swap-tx":{"post":{"summary":"Intent to Swap Transaction","description":"Convert natural language trading intent into an executable swap transaction payload. Compatible with OKX DEX by default.","operationId":"intentToSwap","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentToSwapRequest"}}}},"responses":{"200":{"description":"Swap transaction generated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwapTransactionResponse"}}}},"401":{"description":"Unauthorized - Invalid or missing API key"}}}}}} ``` 将自然语言交易意图转换为可执行的交换交易负载，默认兼容 OKX DEX。 | 参数 | 类型 | 必需 | 描述 | | --------------- | --- | -- | ------------------------------------ | | `intent` | 字符串 | 是 | 自然语言交换意图（例如，“将 0.1 ETH 兑换为 USDC”） | | `walletAddress` | 字符串 | 是 | 用户钱包地址（0x...） | | `chain` | 字符串 | 否 | 链名称（例如，“base”、“ethereum”、“arbitrum”） | **示例：** ```bash curl -X POST https://api.minara.ai/v1/developer/intent-to-swap-tx \\ -H "Authorization: Bearer " \\ -H "Content-Type: application/json" \\ -d '{ "intent": "将 0.1 ETH 兑换为 USDC", "walletAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1", "chain": "base" }' ``` *** ### 永续交易建议 **`POST /v1/developer/perp-trading-suggestion`** ## Perpetual Trading Suggestion > Get AI-powered perpetual trading suggestions with long/short recommendations, entry price, stop loss, take profit levels, and confidence score based on comprehensive market analysis. ```json {"openapi":"3.0.0","info":{"title":"Minara Agent API","version":"1.0"},"servers":[{"url":"https://api-developer.minara.ai"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API-KEY","description":"Format: Authorization: Bearer "}},"schemas":{"PerpTradingRequest":{"type":"object","required":["symbol"],"properties":{"symbol":{"type":"string","description":"Required. Trading symbol (e.g., 'BTC', 'ETH', 'SOL')."},"style":{"type":"string","enum":["scalping","day-trading","swing-trading"],"default":"scalping","description":"Optional. Trading style: 'scalping', 'day-trading', or 'swing-trading'. Default: 'scalping'."},"marginUSD":{"type":"number","default":1000,"description":"Optional. Margin in USD. Default: 1000."},"leverage":{"type":"number","default":10,"minimum":1,"maximum":40,"description":"Optional. Leverage multiplier (max: 40). Default: 10."},"strategy":{"type":"string","default":"max-profit","description":"Optional. Strategy type. Default: 'max-profit'. More strategies coming soon."}}},"PerpTradingResponse":{"type":"object","properties":{"entryPrice":{"type":"number","description":"Recommended entry price."},"side":{"type":"string","enum":["long","short"],"description":"Trading side recommendation."},"stopLossPrice":{"type":"number","description":"Recommended stop loss price."},"takeProfitPrice":{"type":"number","description":"Recommended take profit price."},"confidence":{"type":"number","minimum":0,"maximum":100,"description":"Confidence score (0-100)."},"reasons":{"type":"array","items":{"type":"string"},"description":"Analysis reasons based on technical indicators."},"risks":{"type":"array","items":{"type":"string"},"description":"Risk factors to consider."}}}}},"paths":{"/v1/developer/perp-trading-suggestion":{"post":{"summary":"Perpetual Trading Suggestion","description":"Get AI-powered perpetual trading suggestions with long/short recommendations, entry price, stop loss, take profit levels, and confidence score based on comprehensive market analysis.","operationId":"perpTradingSuggestion","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerpTradingRequest"}}}},"responses":{"200":{"description":"Perpetual trading suggestion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerpTradingResponse"}}}},"401":{"description":"Unauthorized - Invalid or missing API key"}}}}}} ``` 获取由 AI 驱动的永续交易建议，包括做多/做空建议、入场点、止损、止盈和置信度评分。 | 参数 | 类型 | 必需 | 描述 | | ----------- | --- | -- | -------------------------- | | `symbol` | 字符串 | 是 | 交易标的（例如，“BTC”、“ETH”、“SOL”） | | `style` | 字符串 | 否 | `剥头皮`, `日内交易`，或者 `波段交易` | | `marginUSD` | 数字 | 否 | 以美元计的保证金 | | `leverage` | 数字 | 否 | 杠杆倍数（最大：40） | | `strategy` | 字符串 | 否 | 策略类型 | **示例：** ```bash curl -X POST https://api.minara.ai/v1/developer/perp-trading-suggestion \\ -H "Authorization: Bearer " \\ -H "Content-Type: application/json" \\ -d '{ "symbol": "BTC", "style": "日内交易", "marginUSD": 1000, "leverage": 10 }' ``` *** ### 预测市场分析 **`POST /v1/developer/prediction-market-ask`** ## Prediction Market Analysis > AI-powered prediction market analysis. Analyze prediction market events and get probability estimates for each outcome with detailed reasoning. ```json {"openapi":"3.0.0","info":{"title":"Minara Agent API","version":"1.0"},"servers":[{"url":"https://api-developer.minara.ai"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API-KEY","description":"Format: Authorization: Bearer "}},"schemas":{"PredictionMarketRequest":{"type":"object","required":["link","mode"],"properties":{"link":{"type":"string","description":"Required. Prediction market page link (e.g., Polymarket event URL)."},"mode":{"type":"string","enum":["fast","expert"],"description":"Required. Chat mode: 'fast' or 'expert'."},"only_result":{"type":"boolean","default":false,"description":"Optional. Only return prediction probabilities without reasoning. Default: false."},"customPrompt":{"type":"string","description":"Optional. Custom instructions to guide the analysis. Use this to specify focus areas, risk preferences, or analysis style."}}},"PredictionMarketResponse":{"type":"object","properties":{"predictions":{"type":"array","description":"Array of prediction outcomes. Each outcome represents an event option with its yes/no probabilities.","items":{"type":"object","properties":{"outcome":{"type":"string","description":"Outcome name (event option, e.g., candidate name, team name)."},"yesProb":{"type":"number","description":"Probability of YES for this outcome (0-1)."},"noProb":{"type":"number","description":"Probability of NO for this outcome (0-1)."}}}},"reasoning":{"type":"string","description":"AI reasoning and analysis (empty if only_result=true)."}}}}},"paths":{"/v1/developer/prediction-market-ask":{"post":{"summary":"Prediction Market Analysis","description":"AI-powered prediction market analysis. Analyze prediction market events and get probability estimates for each outcome with detailed reasoning.","operationId":"predictionMarketAsk","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredictionMarketRequest"}}}},"responses":{"200":{"description":"Prediction market analysis","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredictionMarketResponse"}}}},"401":{"description":"Unauthorized - Invalid or missing API key"}}}}}} ``` 获取由 AI 驱动的预测市场结果概率估计。 | 参数 | 类型 | 必需 | 描述 | | -------------- | --- | -- | ------------------------- | | `link` | 字符串 | 是 | 预测市场事件 URL（例如，Polymarket） | | `mode` | 字符串 | 是 | `快速` 或 `专家` | | `only_result` | 布尔值 | 否 | 仅返回概率，不包含推理 | | `customPrompt` | 字符串 | 否 | 用于引导分析的自定义指令 | **示例：** ```bash curl -X POST https://api.minara.ai/v1/developer/prediction-market-ask \\ -H "Authorization: Bearer " \\ -H "Content-Type: application/json" \\ -d '{ "link": "https://polymarket.com/event/example", "mode": "快速" }' ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://minara.ai/docs/minara-handbook/zh/jiao-yi/agent-api/api-key.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.