> 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/es/operar/agent-api/api-reference-api-key.md). # Referencia de la API (clave de API) Especificaciones técnicas de los puntos finales de la API del Agente Minara. ### API para desarrolladores El punto final principal para interactuar con la IA conversacional de Minara. ## 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."}}}}}} ``` ## API para desarrolladores ## Chat ### Punto final `POST https://api.minara.ai/v1/developer/chat` ### Cuerpo de la solicitud | Parámetro | Tipo | Requerido | Descripción | | ----------------- | -------- | --------- | --------------------------------------------------------------------------------------- | | `modo` | cadena | Sí | Modo del modelo: 'fast' para respuestas rápidas, 'expert' para análisis en profundidad. | | `flujo` | booleano | Sí | Establécelo en true para streaming (SSE), false para una respuesta JSON estándar. | | `mensaje` | objeto | Sí | Objeto de mensaje con rol y contenido | | `message.role` | cadena | Sí | Rol del remitente del mensaje; debe ser 'user'. | | `message.content` | cadena | Sí | El contenido de la consulta del usuario. | ### Solicitud de ejemplo ```bash curl -X POST https://api.minara.ai/v1/developer/chat \\ -H "Authorization: Bearer " \\ -H "Content-Type: application/json" \\ -d '{ "mode": "rápido", "stream": false, "message": { "role": "user", "content": "Analiza la acción reciente del precio de SOL y dame una sugerencia de trading." } }' ``` ### Respuestas #### Respuesta estándar (stream: false) Devuelve un objeto JSON con la respuesta completa. ```json { "chatId": "chat_abc123", "messageId": "msg_def456", "content": "SOL actualmente se cotiza a $187.50, un 4.2% más en las últimas 24 horas. Basado en el gráfico de 4H, ha superado la resistencia clave en $185 con un volumen fuerte. El RSI está en 62, lo que indica un impulso alcista sin estar sobrecomprado. \n\nSugerencia: Considera una posición larga con entrada alrededor de $186-188, toma ganancias en $195 y stop loss en $180...", "usage": {} } ``` #### Respuesta en streaming (stream: true) Devuelve `Content-Type: text/event-stream` usando Server-Sent Events (SSE). ``` 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 actualmente se cotiza a $187.50, un 4.2% más en las últimas 24 horas.\n"},"finish_reason":null}]} data: {"chatId":"chat_abc123","messageId":"msg_def456","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"Basado en el gráfico de 4H, ha superado la resistencia clave en $185 con un volumen fuerte.\n"},"finish_reason":null}]} data: [DONE] ``` *** ## Transacción de intención de swap ### Punto final `POST https://api.minara.ai/v1/developer/intent-to-swap-tx` Convierte una intención de trading en lenguaje natural en una carga útil de transacción de swap ejecutable. Compatible con OKX DEX por defecto. ### Cuerpo de la solicitud | Parámetro | Tipo | Requerido | Descripción | | --------------- | ------ | --------- | ------------------------------------------------------------------------------- | | `intent` | cadena | Sí | Intención de swap en lenguaje natural (p. ej., "swap 0.1 ETH por USDC") | | `walletAddress` | cadena | Sí | Dirección de la cartera del usuario (0x...) | | `chain` | cadena | No | Nombre de la cadena (p. ej., "base", "ethereum", "bsc", "arbitrum", "optimism") | ### Solicitud de ejemplo ```bash curl -X POST https://api.minara.ai/v1/developer/intent-to-swap-tx \\ -H "Authorization: Bearer " \\ -H "Content-Type: application/json" \\ -d '{ "intent": "intercambia 0.1 ETH por USDC", "walletAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1", "chain": "base" }' ``` ### Respuesta ```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": "La autorización es suficiente para el spender 0x57df6092665eb6058DE53939612413ff4B09114E" } } ``` *** ## Sugerencia de trading perpetuo ### Punto final `POST https://api.minara.ai/v1/developer/perp-trading-suggestion` Obtén sugerencias de trading perpetuo impulsadas por IA con recomendaciones de largo/corto, precio de entrada, stop loss, niveles de take profit y puntuación de confianza basada en un análisis integral del mercado. ### Cuerpo de la solicitud | Parámetro | Tipo | Requerido | Descripción | | ----------- | ------ | --------- | -------------------------------------------------------------- | | `symbol` | cadena | Sí | Símbolo de trading (p. ej., "BTC", "ETH", "SOL") | | `style` | cadena | No | Estilo de trading: "scalping", "day-trading" o "swing-trading" | | `marginUSD` | número | No | Margen en USD | | `leverage` | número | No | Multiplicador de apalancamiento (máx.: 40) | | `strategy` | cadena | No | Tipo de estrategia (más estrategias próximamente) | ### Solicitud de ejemplo ```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": "day trading", "marginUSD": 1000, "leverage": 10, "strategy": "max-profit" }' ``` ### Respuesta ```json { "entryPrice": 98450, "side": "long", "stopLossPrice": 96200, "takeProfitPrice": 102800, "confidence": 78, "reasons": [ "BTC rompió por encima de la resistencia clave en $97,500 con un fuerte volumen", "RSI en 62 indica impulso alcista sin estar sobrecomprado", "MACD mostrando un cruce alcista en el marco temporal de 4H", "El perfil de volumen muestra acumulación en los niveles actuales" ], "risks": [ "Posible retroceso en la resistencia psicológica de $100,000", "Se espera alta volatilidad alrededor de la próxima reunión de la Fed", "Las tasas de financiación en los principales exchanges muestran una tendencia al alza" ] } ``` *** ## Análisis del mercado de predicción ### Punto final `POST https://api.minara.ai/v1/developer/prediction-market-ask` Análisis del mercado de predicción impulsado por IA. Analiza eventos del mercado de predicción y obtén estimaciones de probabilidad para cada resultado con razonamiento detallado. ### Cuerpo de la solicitud | Parámetro | Tipo | Requerido | Descripción | | -------------- | -------- | --------- | ------------------------------------------------------------------------------------ | | `enlace` | cadena | Sí | Enlace de la página del mercado de predicción (p. ej., URL del evento de Polymarket) | | `modo` | cadena | Sí | Modo de chat: "fast" o "expert" | | `only_result` | booleano | No | Devuelve solo las probabilidades de predicción sin razonamiento | | `customPrompt` | cadena | No | Instrucciones personalizadas para guiar el análisis | ### Solicitud de ejemplo ```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": "rápido", "only_result": false, "customPrompt": "Céntrate en las noticias recientes y el análisis de sentimiento. Sé más conservador en las estimaciones de probabilidad." }' ``` ### Respuesta ```json { "predictions": [ { "outcome": "Donald Trump", "yesProb": 0.65, "noProb": 0.35 }, { "outcome": "Kamala Harris", "yesProb": 0.3, "noProb": 0.7 } ], "reasoning": "Basado en datos recientes de encuestas y tendencias históricas, Trump mantiene una ligera ventaja en estados clave indecisos. Sin embargo, la contienda sigue siendo muy competitiva, con una incertidumbre significativa..." } ``` --- # 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/es/operar/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.