API Documentation
Request
Response
{ "status": "success", "generated_story": "GENERATED_STORY, "remaining_generation": "YOUR_REMAINING_GENERATIONS" }
Error response
{ "status": "fail", "error": "ERROR_TYPE", "message": "ERROR_MESSAGE" }
ParametersThis will genrate from your profile page. And it's datatype must be a string. Get your API KeyYou can provide more context/reference about the image so that our AI can write accordingly.You can provide a story type from below listed story key.Story type and description
Story type Story key ( For URL) Description LinkedIn motivational story linkedin-motivational-story This will generate a motivational story based on Image uploaded by user which inspires and encourages individuals to strive for their goals, overcome obstacles, and achieve success despite adversity. LinkedIn general post linkedin-general-post This will generate a LinkedIn post related to Image uploaded by user, which allows users to share their thoughts, ideas, and insights with their professional network on the platform. Instagram short caption instagram-short-caption This will generate a short description of Image for Instagram uploaded by user to express context, share their thoughts or call to action. Instagram long story instagram-long-story This will generate a Slighter long description of Image for Instagram which includes more in-depth information, tell a story, or give a behind the scenes look at a project or event. Facebook short caption facebook-short-caption This will generate a short description of Image for FaceBook uploaded by user to express context, share their thoughts or call to action. Facebook long story facebook-long-story This will generate a Slighter long description of Image for FaceBook which includes more in-depth information, tell a story, or give a behind the scenes look at a project or event. Provide a server url in this key. And If you want to use this field blob_image must be false.This will be True or False. If you set a True, API will accept a raw_image insted of image_url. And If you set False, API will accept a image_url instad of raw_image.This will accept a loacl image from your system. In this filed provide a relative path of your image and blob_image must be 'True'.
Error code and description
Error Description api_key There is no API key in the request JSON. ( You can get your API key here. ) image_context There is no Image context in the request JSON. story_type There is no story_type in the request JSON or Invalid story type ( Select story type from table) image_url There is no image url in the request JSON. raw_image You have set blob_image True and there is no image in the request JSON. no-user Invalid API key ( You can get your API key here. ) free-trial-expired Your free trial is expired. daily-limit-reached Your API calls for today are over. long text image_contex should be less than 100 charcters. 3-words image_contex should be containing minimum 3 words. 30-words image_contex should not be containing more than 30 words. valid_image image should be from (jpg, png or jpeg) invalid-url Provide valid image URL error_in_api Server is not responding. Try again later.