Getting Started
Technical Documentation
Advanced Topics
Home›
API Documentation
Business Plan Analysis API
Endpoint
POST
https://ideax.in/api/get-idea-result
Description
This API analyzes user inputs about their business idea, circumstances, and plans to generate a comprehensive business plan analysis and success prediction.
Authentication
Authentication is not required.
Endpoint | POST https://ideax.in/api/get-idea-result |
---|---|
Description | This API analyzes user inputs about their business idea, circumstances, and plans to generate a comprehensive business plan analysis and success prediction. |
Authentication | Authentication is not required. |
Request Parameters
All numeric parameters must be integers. The request body should be a JSON object containing:
Parameter Reference
Parameter | Type | Required | Validation Rules | Description |
---|---|---|---|---|
idea_stage | Integer | Yes | One of: 1, 2, 3 | Idea Stage |
work_status | Integer | Yes | One of: 1, 2, 3, 4, 5 | Work Status |
project_type | Integer | Yes | One of: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21 | Project Type |
job_relation | Integer | Yes | One of: 1, 2 | Job Relation |
investment_plan | Integer | Yes | One of: 1, 2, 3, 4, 5 | Investment Plan |
work_experience | Integer | Yes | One of: 1, 2, 3, 4 | Work Experience |
daily_hours | Integer | Yes | One of: 1, 2, 3, 4, 5 | Daily Hours |
timeframe | Integer | Yes | One of: 1, 2, 3 | Timeframe |
Example Request
{ "idea_stage": 2, "work_status": 3, "project_type": 3, "job_relation": 1, "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 URL
https://ideax.in/api/widget/:uniqueKey
Endpoint
GET
/api/widget/:uniqueKey
Response
The 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
Base URL | https://ideax.in/api/widget/:uniqueKey |
---|---|
Endpoint | GET /api/widget/:uniqueKey |
Response | The API returns an HTML response that includes:
|
Example Request
<iframe src="https://idxsolana.io/api/widget/abc123" width="300" height="200" style="border: none;"> </iframe>