🤖 API Documentation - Core AI Endpoints

🚀 Overview

Artificial intelligence endpoints with OpenAI integration, including ChatGPT, DALL-E, Whisper and GPT-4 Vision.

💬 Endpoint 1: ChatGPT Complete

Description

Complete AI chat using OpenAI GPT models with support for custom prompts.

URL

POST /api/chat

Headers

Content-Type: application/json
X-RapidAPI-Key: {{rapidapi_key}}
X-RapidAPI-Host: {{rapidapi_host}}

Parameters

Field	Type	Required	Description
`message`	String	Yes	Message to send to ChatGPT
`model`	String	No	Model to use (default: "gpt-3.5-turbo")
`systemPrompt`	String	No	System prompt (default: "You are a helpful AI assistant.")

Request Example

{
  "message": "Explain what artificial intelligence is in 3 sentences",
  "model": "gpt-3.5-turbo",
  "systemPrompt": "You are a helpful AI assistant."
}

Response Example

{
  "success": true,
  "response": "Artificial intelligence is a field of computer science that aims to create systems capable of performing tasks that typically require human intelligence. These systems can learn from data, recognize patterns, and make decisions based on processed information. AI is transforming various industries, from healthcare to transportation, by automating processes and creating new technological possibilities.",
  "model": "gpt-3.5-turbo",
  "usage": {
    "prompt_tokens": 15,
    "completion_tokens": 89,
    "total_tokens": 104
  }
}

Endpoint 2: DALL-E Image Generation

Description

Generate images using OpenAI's DALL-E model based on textual prompts.

URL

POST /api/generate-image

Headers

Content-Type: application/json
X-RapidAPI-Key: {{rapidapi_key}}
X-RapidAPI-Host: {{rapidapi_host}}

Parameters

Field	Type	Required	Description
`prompt`	String	Yes	Description of the image to generate
`size`	String	No	Image size (default: "1024x1024")

Request Example

{
  "prompt": "A space cat with futuristic glasses, cartoon style",
  "size": "1024x1024"
}

Response Example

{
  "success": true,
  "image_url": "https://oaidalleapiprodscus.blob.core.windows.net/private/...",
  "prompt": "A space cat with futuristic glasses, cartoon style",
  "size": "1024x1024"
}

🎤 Endpoint 3: Whisper Audio Transcription

Description

Transcribe audio to text using OpenAI's Whisper model.

URL

POST /api/transcribe

Headers

X-RapidAPI-Key: {{rapidapi_key}}
X-RapidAPI-Host: {{rapidapi_host}}

Parameters

Field	Type	Required	Description
`audio`	File	Yes	Audio file to transcribe

Request Example

Send audio file via form-data with key "audio"

Response Example

{
  "success": true,
  "text": "Hello, this is a test transcription of the uploaded audio.",
  "language": "en",
  "duration": 5.2,
  "segments": [
    {
      "start": 0.0,
      "end": 5.2,
      "text": "Hello, this is a test transcription of the uploaded audio."
    }
  ]
}

Endpoint 4: GPT-4 Vision Image Analysis

Description

Analyze images using GPT-4 Vision and provide detailed descriptions.

URL

POST /api/analyze-image

Headers

Content-Type: application/json
X-RapidAPI-Key: {{rapidapi_key}}
X-RapidAPI-Host: {{rapidapi_host}}

Parameters

Field	Type	Required	Description
`image_url`	String	Yes	URL of the image to analyze
`prompt`	String	No	Specific prompt for analysis (default: "Analyze this image in detail")

Request Example

{
  "image_url": "https://example.com/image.jpg",
  "prompt": "Describe this image in detail"
}

Response Example

{
  "success": true,
  "analysis": "This image shows a modern urban scene with tall buildings and a busy street. There are people walking on the sidewalk and cars passing by. The sky is partially cloudy and the lighting suggests it's a sunny day. The architecture of the buildings is contemporary, with straight lines and large glass windows...",
  "prompt": "Describe this image in detail"
}

💰 Endpoint 5: Financial Analysis

Description

Complete financial analysis with AI-powered insights and recommendations.

URL

POST /api/financial-analysis

Headers

Content-Type: application/json
X-RapidAPI-Key: {{rapidapi_key}}
X-RapidAPI-Host: {{rapidapi_host}}

Parameters

Field	Type	Required	Description
`data`	Object	Yes	Financial data for analysis
`analysis_type`	String	No	Type of analysis (default: "comprehensive")

Request Example

{
  "data": {
    "revenue": 100000,
    "expenses": 80000,
    "profit": 20000,
    "assets": 500000,
    "liabilities": 200000
  },
  "analysis_type": "comprehensive"
}

Response Example

{
  "success": true,
  "analysis": "Complete financial analysis: Your company shows a 20% profit margin, which is considered healthy for the industry. Return on Assets (ROA) is 4%, indicating good efficiency in resource utilization. Recommendations: 1) Consider marketing investments to increase revenue, 2) Optimize operational costs, 3) Diversify revenue sources...",
  "analysis_type": "comprehensive",
  "timestamp": "2024-01-15T10:00:00.000Z"
}

Endpoint 6: Market Analysis

Description

Market analysis and trends with investment insights.

URL

POST /api/market-analysis

Headers

Content-Type: application/json
X-RapidAPI-Key: {{rapidapi_key}}
X-RapidAPI-Host: {{rapidapi_host}}

Parameters

Field	Type	Required	Description
`market_type`	String	No	Market type (default: "general")
`specific_stocks`	Array	No	Specific stocks for analysis
`sector`	String	No	Specific sector
`timeframe`	String	No	Analysis period (default: "current")
`analysis_depth`	String	No	Analysis depth (default: "comprehensive")

Request Example

{
  "market_type": "stocks",
  "specific_stocks": ["AAPL", "GOOGL", "TSLA"],
  "sector": "technology",
  "timeframe": "current",
  "analysis_depth": "comprehensive"
}

Response Example

{
  "success": true,
  "market_analysis": "Technology market analysis: The technology sector continues to show strong growth, driven by AI innovation and cloud computing. AAPL shows resilience with strong user base, GOOGL leads in generative AI, and TSLA faces increasing competition. Recommendations: 1) Diversify investments in the sector, 2) Focus on companies with strong innovation, 3) Monitor AI regulations...",
  "market_type": "stocks",
  "specific_stocks": ["AAPL", "GOOGL", "TSLA"],
  "sector": "technology",
  "timeframe": "current",
  "analysis_depth": "comprehensive",
  "analyzed_at": "2024-01-15T10:00:00.000Z"
}

💻 Endpoint 7: Code Assistant

Description

Code assistant with support for multiple programming languages.

URL

POST /api/code-assistant

Headers

Content-Type: application/json
X-RapidAPI-Key: {{rapidapi_key}}
X-RapidAPI-Host: {{rapidapi_host}}

Parameters

Field	Type	Required	Description
`request`	String	Yes	Code request
`language`	String	No	Programming language (default: "javascript")
`context`	String	No	Additional context

Request Example

{
  "request": "Create a function to calculate fibonacci numbers",
  "language": "javascript",
  "context": "Performance optimization needed"
}

Response Example

{
  "success": true,
  "code_solution": "// Optimized function to calculate Fibonacci numbers\nfunction fibonacci(n) {\n  if (n <= 1) return n;\n  \n  let a = 0, b = 1;\n  for (let i = 2; i <= n; i++) {\n    [a, b] = [b, a + b];\n  }\n  return b;\n}\n\n// Usage example\nconsole.log(fibonacci(10)); // 55\n\n// Memoized version for better performance\nconst fibonacciMemo = (() => {\n  const cache = {};\n  return (n) => {\n    if (n in cache) return cache[n];\n    if (n <= 1) return n;\n    cache[n] = fibonacciMemo(n-1) + fibonacciMemo(n-2);\n    return cache[n];\n  };\n})();",
  "language": "javascript",
  "request": "Create a function to calculate fibonacci numbers"
}

🔍 Endpoint 8: Semantic Search

Description

Semantic search in documents using AI to find relevant results.

URL

POST /api/semantic-search

Headers

Content-Type: application/json
X-RapidAPI-Key: {{rapidapi_key}}
X-RapidAPI-Host: {{rapidapi_host}}

Parameters

Field	Type	Required	Description
`query`	String	Yes	Search query
`documents`	Array	Yes	Array of documents to search
`max_results`	Number	No	Maximum number of results (default: 5)

Request Example

{
  "query": "machine learning algorithms",
  "documents": [
    "Document about AI and ML",
    "Guide to deep learning",
    "Introduction to neural networks",
    "Data science fundamentals",
    "Python programming basics"
  ],
  "max_results": 3
}

Response Example

{
  "success": true,
  "search_results": "Semantic search results:\n\n1. Document about AI and ML (Relevance: 95%)\n   - Most relevant document for your query about machine learning algorithms\n\n2. Guide to deep learning (Relevance: 88%)\n   - Comprehensive guide on deep learning, which is a subset of ML\n\n3. Introduction to neural networks (Relevance: 82%)\n   - Introduction to neural networks, fundamental for modern ML\n\nDocuments were ranked by semantic relevance, not just keywords.",
  "query": "machine learning algorithms",
  "max_results": 3
}

📊 Endpoint 9: Data Insights

Description

Advanced data analysis with AI-identified insights and patterns.

URL

POST /api/data-insights

Headers

Content-Type: application/json
X-RapidAPI-Key: {{rapidapi_key}}
X-RapidAPI-Host: {{rapidapi_host}}

Parameters

Field	Type	Required	Description
`data`	Array/Object	Yes	Data for analysis
`analysis_type`	String	No	Type of analysis (default: "comprehensive")
`business_context`	String	No	Business context

Request Example

{
  "data": [
    {"month": "Jan", "sales": 1000},
    {"month": "Feb", "sales": 1200},
    {"month": "Mar", "sales": 1100},
    {"month": "Apr", "sales": 1400},
    {"month": "May", "sales": 1300}
  ],
  "analysis_type": "comprehensive",
  "business_context": "E-commerce sales analysis"
}

Response Example

{
  "success": true,
  "insights": "Complete sales data analysis:\n\n�� **Overall Trend**: Consistent 20% growth over first 5 months\n\n📊 **Identified Patterns**:\n- Sales peak in February (+20%)\n- Drop in March (-8.3%)\n- Recovery in April (+27.3%)\n- Stabilization in May (-7.1%)\n\n🎯 **Actionable Insights**:\n1. Investigate what caused February peak\n2. Analyze March drop to prevent recurrence\n3. Replicate successful April strategies\n\n💡 **Recommendations**:\n- Implement seasonal campaigns in February\n- Optimize operations to avoid March drops\n- Expand successful April strategies",
  "analysis_type": "comprehensive",
  "data_points": 5,
  "analyzed_at": "2024-01-15T10:00:00.000Z"
}

Use Cases

Developers

Code assistant for multiple languages
Image generation for projects
Audio transcription for documentation

Businesses

Automated financial analysis
Market analysis and trends
Data insights for decisions

Researchers

Semantic search in documents
Image analysis with AI
Complex data processing

Benefits

✅ OpenAI Integration - Most advanced models
✅ Multiple functionalities - AI, analysis, code
✅ Easy integration - Standard REST API
✅ Accurate results - State-of-the-art AI
✅ Scalable - Works with any volume

Getting Started

Configure headers with your RapidAPI key
Choose the endpoint suitable for your need
Send data in the correct format
Receive results processed by AI
Integrate in your application to automate processes

Power your application with cutting-edge artificial intelligence! 🚀