> 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/tr/islem/agent-api/api-reference-api-key.md). # API Referansı (API Anahtarı) Minara Agent API uç noktaları için teknik özellikler. ### Geliştirici API Minara'nın konuşmalı yapay zekâsıyla etkileşim için temel uç nokta. ## 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"}}}}}} ``` ## 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"}}}}}} ``` ## 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"}}}}}} ``` ## 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"}}}}}} ``` ## The Message object ```json {"openapi":"3.0.0","info":{"title":"Minara Agent API","version":"1.0"},"components":{"schemas":{"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."}}}}}} ``` ## The ChatResponse object ```json {"openapi":"3.0.0","info":{"title":"Minara Agent API","version":"1.0"},"components":{"schemas":{"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."}}}}}} ``` ## Geliştirici API ## Sohbet ### Uç Nokta `POST https://api.minara.ai/v1/developer/chat` ### İstek Gövdesi | Parametre | Tür | Gerekli | Açıklama | | ----------------- | ----- | ------- | ------------------------------------------------------------------------------ | | `mode` | dize | Evet | Model modu: hızlı yanıtlar için 'fast', ayrıntılı analiz için 'expert'. | | `stream` | bool | Evet | Yayın akışı (SSE) için true, standart JSON yanıtı için false olarak ayarlayın. | | `mesaj` | nesne | Evet | role ve content alanlarına sahip mesaj nesnesi | | `message.role` | dize | Evet | Mesaj gönderenin rolü 'user' olmalıdır. | | `message.content` | dize | Evet | Kullanıcının sorgu içeriği. | ### Örnek İstek ```bash curl -X POST https://api.minara.ai/v1/developer/chat \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "mode": "fast", "stream": false, "message": { "role": "user", "content": "SOL'un son fiyat hareketlerini analiz et ve bana bir alım-satım önerisi ver." } }' ``` ### Yanıtlar #### Standart Yanıt (stream: false) Tam yanıtı içeren bir JSON nesnesi döndürür. ```json { "chatId": "chat_abc123", "messageId": "msg_def456", "content": "SOL şu anda 187,50 $ seviyesinde işlem görüyor ve son 24 saatte %4,2 yükseldi. 4 saatlik grafiğe göre, güçlü hacimle 185 $ seviyesindeki kilit direncin üzerine çıktı. RSI 62 seviyesinde; bu, aşırı alım bölgesine girmeden yükseliş momentumu olduğunu gösteriyor. \n\nÖneri: Girişi 186-188 $ aralığında olan bir uzun pozisyon düşünün, kâr al seviyesini 195 $ olarak belirleyin ve stop loss'u 180 $ seviyesine koyun...", "usage": {} } ``` #### Akış Yanıtı (stream: true) Döndürür `Content-Type: text/event-stream` Server-Sent Events (SSE) kullanılarak. ``` data: {"chatId":"chat_abc123","messageId":"msg_def456","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]} data: {"chatId":"chat_abc123","messageId":"msg_def456","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"SOL şu anda 187,50 $ seviyesinde işlem görüyor ve son 24 saatte %4,2 yükseldi.\n"},"finish_reason":null}]} data: {"chatId":"chat_abc123","messageId":"msg_def456","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"4 saatlik grafiğe göre, güçlü hacimle 185 $ seviyesindeki kilit direncin üzerine çıktı.\n"},"finish_reason":null}]} data: [DONE] ``` *** ## Swap İşlemine Dönüştürme Niyeti ### Uç Nokta `POST https://api.minara.ai/v1/developer/intent-to-swap-tx` Doğal dildeki alım satım niyetini çalıştırılabilir bir swap işlem yüküne dönüştürür. Varsayılan olarak OKX DEX ile uyumludur. ### İstek Gövdesi | Parametre | Tür | Gerekli | Açıklama | | --------------- | ---- | ------- | ------------------------------------------------------------------- | | `intent` | dize | Evet | Doğal dilde swap niyeti (örn. "0.1 ETH'yi USDC'ye çevir") | | `walletAddress` | dize | Evet | Kullanıcı cüzdan adresi (0x...) | | `chain` | dize | Hayır | Zincir adı (örn. "base", "ethereum", "bsc", "arbitrum", "optimism") | ### Örnek İstek ```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'yi USDC'ye çevir", "walletAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1", "chain": "base" }' ``` ### Yanıt ```json { "intent": { "chain": "base", "inputTokenAddress": null, "inputTokenSymbol": "ETH", "outputTokenAddress": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", "outputTokenSymbol": "USDC", "amount": "100000000000000000", "userWalletAddress": "0x42a345F3d379B5060f0C36580bAF22C395B1D462" }, "quote": { "fromTokenAmount": "100000000000000000", "toTokenAmount": "194058559", "estimatedGas": "1338000", "priceImpact": "-0.03", "tradeFee": "0.0174870969512694" }, "inputToken": { "address": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE", "symbol": "ETH", "decimals": "18", "unitPrice": "1960.63" }, "outputToken": { "address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913", "symbol": "USDC", "decimals": "6", "unitPrice": "0.99989" }, "unsignedTx": { "chainType": "evm", "from": "0x42a345F3d379B5060f0C36580bAF22C395B1D462", "to": "0x4409921ae43a39a11d90f7b96cfd0b8093d9fc", "data": "0xf2c42696000000000000000000000000000000000000000000000000000000000003479e...", "value": "100000000000000000", "gas": "1338000", "gasPrice": "10943011", "maxPriorityFeePerGas": "7301883" }, "approval": { "isRequired": false, "tokenAddress": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913", "spenderAddress": "0x57df6092665eb6058DE53939612413ff4B09114E", "requiredAmount": "10000000", "approveAmount": "10000000", "currentAllowance": "115792089237316195423570985008687907853269984665640564039457584007913129316681", "message": "0x57df6092665eb6058DE53939612413ff4B09114E adresindeki harcama yetkilisi için izin yeterli" } } ``` *** ## Sürekli Vadeli İşlem Önerisi ### Uç Nokta `POST https://api.minara.ai/v1/developer/perp-trading-suggestion` Kapsamlı piyasa analizine dayanarak long/short önerileri, giriş fiyatı, stop loss, take profit seviyeleri ve güven skoru içeren yapay zekâ destekli sürekli vadeli işlem önerileri alın. ### İstek Gövdesi | Parametre | Tür | Gerekli | Açıklama | | ----------- | ---- | ------- | ------------------------------------------------------------- | | `symbol` | dize | Evet | İşlem sembolü (örn. "BTC", "ETH", "SOL") | | `style` | dize | Hayır | Trading stili: "scalping", "day-trading" veya "swing-trading" | | `marginUSD` | sayı | Hayır | USD cinsinden marjin | | `leverage` | sayı | Hayır | Kaldıraç çarpanı (maks: 40) | | `strategy` | dize | Hayır | Strateji türü (daha fazla strateji yakında geliyor) | ### Örnek İstek ```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": "gün içi işlem", "marginUSD": 1000, "leverage": 10, "strategy": "max-profit" }' ``` ### Yanıt ```json { "entryPrice": 98450, "side": "long", "stopLossPrice": 96200, "takeProfitPrice": 102800, "confidence": 78, "reasons": [ "BTC güçlü hacimle $97,500 seviyesindeki önemli direncin üzerine çıktı", "RSI'nin 62 seviyesinde olması, aşırı alım olmadan yükseliş momentumu olduğunu gösteriyor", "MACD'nin 4 saatlik zaman diliminde yükseliş kesişimi göstermesi", "Hacim profili mevcut seviyelerde birikim olduğunu gösteriyor" ], "risks": [ "$100,000 psikolojik direncinde olası geri çekilme", "Yaklaşan Fed toplantısı çevresinde yüksek volatilite bekleniyor", "Başlıca borsalardaki fonlama oranları yükseliş eğiliminde" ] } ``` *** ## Tahmin Piyasası Analizi ### Uç Nokta `POST https://api.minara.ai/v1/developer/prediction-market-ask` Yapay zekâ destekli tahmin piyasası analizi. Tahmin piyasası olaylarını analiz edin ve her sonuç için ayrıntılı gerekçeyle olasılık tahminleri alın. ### İstek Gövdesi | Parametre | Tür | Gerekli | Açıklama | | -------------- | ---- | ------- | -------------------------------------------------------------------- | | `link` | dize | Evet | Tahmin piyasası sayfası bağlantısı (örn. Polymarket etkinlik URL'si) | | `mode` | dize | Evet | Sohbet modu: "fast" veya "expert" | | `only_result` | bool | Hayır | Sadece gerekçe olmadan tahmin olasılıklarını döndür | | `customPrompt` | dize | Hayır | Analizi yönlendirmek için özel talimatlar | ### Örnek İstek ```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/will-there-be-another-us-government-shutdown-by-january-31", "mode": "fast", "only_result": false, "customPrompt": "Son haberlere ve duygu analizine odaklanın. Olasılık tahminlerinde daha temkinli olun." }' ``` ### Yanıt ```json { "predictions": [ { "outcome": "Donald Trump", "yesProb": 0.65, "noProb": 0.35 }, { "outcome": "Kamala Harris", "yesProb": 0.3, "noProb": 0.7 } ], "reasoning": "Son anket verilerine ve tarihsel trendlere dayanarak, Trump kilit salıncak eyaletlerde hafif bir üstünlüğü koruyor. Ancak yarış hâlâ önemli belirsizlikle son derece rekabetçi..." } ``` --- # 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: ``` GET https://minara.ai/docs/minara-handbook/tr/islem/agent-api/api-reference-api-key.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.