Getting Started

Technical Documentation

Advanced Topics

Home›
API Documentation

API Documentation

Business Plan Analysis API

EndpointPOST https://ideax.in/api/get-idea-result
DescriptionThis API analyzes user inputs about their business idea, circumstances, and plans to generate a comprehensive business plan analysis and success prediction.
AuthenticationAuthentication is not required.

Request Parameters

All numeric parameters must be integers. The request body should be a JSON object containing:

  • idea_stage: 1 (Still an idea), 3 (Made a plan), 5 (Already started)
  • work_status: 1 (Unemployed), 2 (Working full-time), 3 (Working part-time), etc.
  • project_type: 1 (Services), 2 (Retail), ..., 21 (Other)
  • job_relation: 2 (No), 5 (Yes)
  • investment_plan: 1 (< 1 Lakh ₹), ..., 5 (> 1 Crore ₹)
  • work_experience: 0 (No experience), ..., 5 (More than 5 years)
  • daily_hours: 1 (< 1 hour), ..., 5 (> 6 hours)
  • timeframe: 1 (< 3 months), 2 (3-6 months), 3 (6-12 months)

Parameter Reference

ParameterTypeRequiredValidation RulesDescription
idea_stageIntegerYesOne of: 1, 3, 5Idea Stage
work_statusIntegerYesOne of: 1, 2, 3, 4, 5Work Status
project_typeIntegerYesOne of: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21Project Type
job_relationIntegerYesOne of: 2, 5Job Relation
investment_planIntegerYesOne of: 1, 2, 3, 4, 5Investment Plan
work_experienceIntegerYesOne of: 0, 3, 4, 5Work Experience
daily_hoursIntegerYesOne of: 1, 2, 3, 4, 5Daily Hours
timeframeIntegerYesOne of: 1, 2, 3Timeframe

Example Request

{
  "idea_stage": 5,
  "work_status": 3,
  "project_type": 3,
  "job_relation": 5,
  "investment_plan": 4,
  "work_experience": 4,
  "project_location": 1,
  "idea_description": "AI-powered fitness application that provides personalized workout routines based on user's fitness level and goals",
  "daily_hours": 4,
  "timeframe": 2
}

Response Format

Success Response (200 OK)

{
  "status": 200,
  "error": false,
  "message": "Success",
  "data": {
    "resultText": "Detailed analysis and recommendations...",
    "success_percentage": "75.23"
  }
}

Validation Error Response (400)

{
  "status": 400,
  "error": true,
  "message": "Validation error message",
  "data": null
}

Server Error (500)

{
  "status": 500,
  "error": true,
  "message": "An error occurred while processing your request",
  "data": null
}

Embeddable Widget API

Base URLhttps://ideax.in/api/widget/:uniqueKey
EndpointGET /api/widget/:uniqueKey
ResponseThe API returns an HTML response that includes:
  • Logo: A logo image hosted at https://ideax.in/logo.png.
  • Validation Status: A message confirming the validation status.
  • Success Percentage: The success percentage associated with the unique key.
  • Trustpilot Widget: An embedded Trustpilot widget.

Example Response (HTML)

<iframe
  src="https://idxsolana.io/api/widget/abc123"
  width="300"
  height="200"
  style="border: none;">
</iframe>

Table of Contents