API RESTful
Client-server communication
The client will send requests to the server via HTTPS calls , delivering the request data in JSON format.
The server once processed the request will respond to the client via appropriate HTTPS status codes.
Process of a request
- Client request
The client sends an HTTPS request in json format to the server. The request must contain the authorization Bearer Token obtained through the login API to validate the user, the product_key to be able to identify the service, the website_id that identifies the website/shop from which requests are made, and the information to be sent to the AI to process the result. - Server reception
Once the server receives the request, it verifies through the middleware that the user is authorized and that a product_key, website_id or shop name exists in the request.
Once the request has been approved it will invoke the controller which will check for the existence of a Website for the indicated website_id and whether the related product is authorized and in case of confirmation will add the process to the specific queue. Each product_key will have its own dedicated queue.
Once this phase is completed, a response will be returned to the client, with an appropriate status code and, if successful, the order number.
The order number can be used to trace and show the result via the show API or by entering the platform. - Queue processing
Once added to the order queues, the processes will be processed one by one asynchronously.
Request
Syntax
https://dashboard.contents.com/api/services/orders/create
Method: PUT
Parameters
Body Request:
{ user_id: required|integer product_key: required|string product_step: integer website_id: integer api inputs: <*To be replaced: all data necessary to process the requested service> }
Auth
Bearer Token: string
Login Request
Endpoint
https://dashboard.contents.com/api/services/auth/login
Method: POST
Parameters
Body Request:
{ email: required|string, password: required|string }
Api Output
{ "service-api": "<bearer token to be used for API>", ... }
Language code Request
Endpoint
https://dashboard.contents.com/api/tools/show_language_codes
Method: GET
Parameters
Body Request:
{ "user_id": required|integer }
Api Output
{ "status": "success", "result": [ { "language_code": "en", "name": "British English" }, { "language_code": "it", "name": "Italian" }, { "language_code": "es", "name": "Spanish" }, { "language_code": "fr", "name": "French" }, ... }
Tool Request
AI Chat
AI Art
Seo Articles
Image Upscaling
Ecommerce description by keywords
Ecommerce product description By Amazon
Translations
Social Media Post Generator
Product key: ai_chat_conversational
Method: PUT
Parameters
{ "product_key" : "ai_chat_conversational", "user_id": required|integer, "prompt": required|string|max:5000, "language" : required|string, "website_id" : integer, }
Product key: article_generator
Method: PUT
Product type: titles
Parameters
{ "product_key" : "article_generator", "user_id": required|integer, "product_type": "titles", "input": required_if:product_type,titles,titles_paragraphs|string|max:5000, "language" : required_if:product_type,titles,titles_paragraphs|string, "article_len": required_if:product_type,titles,titles_paragraphs|integer|in:500,1000,2000, "tov": required_if:product_type,titles,titles_paragraphs|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, "website_id": integer }
Product key: article_generator
Method: PUT
Product type: paragraphs
Parameters
{ "product_key" : required|string, "user_id": required|integer, "product_type": required|string, "title": string, "title_paragraphs": string, "website_id": integer, "order_det_id": required_if:product_type,paragraphs|integer (this is the order detail id generated after the call that create titles) }
Product key: article_generator
Method: PUT
Product type: titles_paragraphs
Parameters
{ "product_key" : "article_generator", "user_id": required|integer, "product_type": "titles_paragraphs", "input": required_if:product_type,titles,titles_paragraphs|string|max:5000, "language" : required_if:product_type,titles,titles_paragraphs|string, "article_len": required_if:product_type,titles,titles_paragraphs|integer|in:500,1000,2000, "tov": required_if:product_type,titles,titles_paragraphs|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, "website_id": integer }
Product key: seo_steps
Method: PUT
Product type: titles
Parameters
{ "product_key" : "seo_steps", "user_id": required|integer, "product_type": "titles", "instruction": required_if:product_type,titles,titles_paragraphs|string|max:150, "language" : required_if:product_type,titles,titles_paragraphs|string, "article_len": required_if:product_type,titles,titles_paragraphs|integer|in:500,1000,2000, "tov": required_if:product_type,titles,titles_paragraphs|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, "website_id": integer }
Product key: seo_steps
Method: PUT
Product type: paragraphs
Parameters
{ "product_key" : required|string, "user_id": required|integer, "product_type": required|string, "title": string, "title_paragraphs": string, "website_id": integer, "order_det_id": required_if:product_type,paragraphs|integer (this is the order detail id generated after the call that create titles) }
Product key: seo_steps
Method: PUT
Product type: titles_paragraphs
Parameters
{ "product_key" : "seo_steps", "user_id": required|integer, "product_type": "titles_paragraphs", "instruction": required_if:product_type,titles,titles_paragraphs|string|max:5000, "language" : required_if:product_type,titles,titles_paragraphs|string, "article_len": required_if:product_type,titles,titles_paragraphs|integer|in:500,1000,2000, "tov": required_if:product_type,titles,titles_paragraphs|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, "website_id": integer }
Product key: translations_without_revision
Method: PUT
Parameters
{ "product_key" : "translations_without_revision", "user_id": required|integer, "title": required|string, "content": required|string, "language_from" : required|string, "language_to": required|array "website_id": integer }
Product key: translations_with_revision
Method: PUT
Parameters
{ "product_key" : "translations_with_revision", "user_id": required|integer, "title": required|string, "content": required|string, "language_from" : required|string, "language_to": required|array "website_id": integer }
Product key: ai_keywords
Method: PUT
Parameters
{ "product_key" : "ai_keywords", "user_id": required|integer, "title": string, "keywords": required|string, "language” : required|string, "website_id": integer }
Product key: ai_keywords_proofreading
Method: PUT
Parameters
{ "product_key" : required|string, "user_id": required|integer, "title": string, "keywords": required|string, "language” : required|string, "website_id": integer }
Product key: ai_amazon
Method: PUT
Parameters
{ "product_key" : "ai_amazon", "user_id": required|integer, "title": required|string, "asin_or_query_select": required|string|asin,query, "asin_or_query": required|string, "language” : required|string, "website_id": integer }
Endpoint: api/services/media/orders/create
Product key: text_to_image
Method: POST
Parameters
{ "product_key" : "text_to_image", "user_id": required|integer, "title": string, "description" : required|string, "style" : required|string, "exclude" : string, "resolution" : string, "num_images" : integer, "website_id" : integer, }
Available styles: photography, illustration, painting, graphic design, digital art
Available resolutions: 256*256, 512*512, 1024*1024
Endpoint: api/services/media/orders/create
Product key: text_to_video
Method: POST
Parameters
{ "product_key" : "text_to_video", "user_id": required|integer, "title": string, "scene_1" : required|string, "scene_2" : required|string, "style" : required|string|in:None,3d-model,analog-film,anime,cinematic,comic-book,digital-art,enhancefantasy-art,isometric,line-art,low-poly,modeling-compound,neon-punk,origami,photographic,pixel-art, "exclude" : string, "aspect_ratio" : required|string|landscape|portrait|square, "duration" : required|integer|in;3,4,5,6,7,8,9,10 "website_id" : integer, }
Endpoint: api/services/media/orders/create
Product key: image_upscaling
Method: POST
Parameters
{ "product_key" : "image_upscaling", "user_id": required|integer, "title": string, "image" : required|file, "upscaling" : required|integer, "website_id" : integer, }
Available upscaling values: 2, 4
Max available final pixel resolutions:
x2 upscaling: 4194304 total pixels
x4 upscaling: 6291456 total pixels
Endpoint: api/services/media/orders/create
Product key: quality_enhancer
Method: POST
Parameters
{ "product_key" : "quality_enhancer", "user_id": required|integer, "title": string, "image" : required|file, "scale_factor" : 1, "website_id" : integer, }
Product key: social_media_post
Method: PUT
Parameters
{ "product_key" : "social_media_post", "user_id": required|integer, "title": string, "channel" : required|string, "language" : required|string, "website_id" : integer, }
Available channels: Instagram, Facebook, Linkedin, Twitter
Product key: content-rewriter
Method: PUT
Parameters
{ "product_key" : "content-rewriter", "user_id": required|integer, "text": required|string, "language" : required|string, "tov": required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, "website_id" : integer, }
Product key: instagram-hashtags
Method: PUT
Parameters
{ "product_key" : "instagram-hashtags", "user_id" : required|integer, "language" : required|string, "title" : required|string, "keywords" : required|string, "creativity" : required|in:0,0.5,1, }
Product key: content-rewriter
Method: PUT
Parameters
{ "product_key" : "content-rewriter", "user_id" : required|integer, "language" : required|string, "text" : required|string, "tone" : "neutral", "creativity" : required|in:0,0.5,1, }
Product key: paragraph-generator
Method: PUT
Parameters
{ "product_key" : "paragraph-generator", "user_id" : required|integer, "language" : required|string, "title" : required|string, "keywords" : required|string, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, "creativity" : required|in:0,0.5,1, }
Product key: talking-points
Method: PUT
Parameters
{ "product_key" : "talking-points", "user_id" : required|integer, "language" : required|string, "title" : required|string, "keywords" : required|string, "creativity" : required|in:0,0.5,1, "description" : required|string, "tone" : required|string|in:funny,casual,excited,professional,witty,sarcastic,feminine,masculine,bold,dramatic,gumpy,secretive, }
Product key: pros-and-cons
Method: PUT
Parameters
{ "product_key" : "pros-and-cons", "user_id" : required|integer, "language" : required|string, "title" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: blog-titles
Method: PUT
Parameters
{ "product_key" : "blog-titles", "user_id" : required|integer, "language" : required|string, "title" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, }
Product key: blog-section
Method: PUT
Parameters
{ "product_key" : "blog-section", "user_id" : required|integer, "language" : required|string, "title" : required|string, "subheadings" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: blog-ideas
Method: PUT
Parameters
{ "product_key" : "blog-ideas", "user_id" : required|integer, "language" : required|string, "title" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: blog-intros
Method: PUT
Parameters
{ "product_key" : "blog-intros", "user_id" : required|integer, "language" : required|string, "title" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: blog-conclusion
Method: PUT
Parameters
{ "product_key" : "blog-conclusion", "user_id" : required|integer, "language" : required|string, "title" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: summarize-text
Method: PUT
Parameters
{ "product_key" : "summarize-text", "user_id": required|integer, "language" : required|string, "title" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: product-description
Method: PUT
Parameters
{ "product_key" : "product-description", "user_id" : required|integer, "title" : required|string, "audience" : required|string, "description" : required|string, "language" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: startup-name-generator
Method: PUT
Parameters
{ "product_key" : "startup-name-generator", "user_id" : required|integer, "title" : required|string, "language" : required|string, "keywords" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, }
Product key: product-name-generator
Method: PUT
Parameters
{ "product_key" : "product-name-generator", "user_id" : required|integer, "title" : required|string, "language" : required|string, "keywords" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, }
Product key: meta-description
Method: PUT
Parameters
{ "product_key" : "meta-description", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "keywords" : required|string, "creativity" : required|in:0,0.5,1, }
Product key: faq
Method: PUT
Parameters
{ "product_key" : "faqs", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: faq-answers
Method: PUT
Parameters
{ "product_key" : "faq-answers", "user_id" : required|integer, "title" : required|string, "language" : required|string, "question": : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: testimonials
Method: PUT
Parameters
{ "product_key" : "testimonials", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: facebook-ads
Method: PUT
Parameters
{ "product_key" : "facebook-ads", "user_id" : required|integer, "title" : required|string, "language" : required|string, "audience" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: video-descriptions
Method: PUT
Parameters
{ "product_key" : "video-descriptions", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: video-titles
Method: PUT
Parameters
{ "product_key" : "video-titles", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, }
Product key: youtube-tags-generator
Method: PUT
Parameters
{ "product_key" : "youtube-tags-generator", "user_id" : required|integer, "title" : required|string, "language" : required|string, "creativity" : required|in:0,0.5,1, }
Product key: instagram-captions
Method: PUT
Parameters
{ "product_key" : "instagram-captions", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: instagram-hashtags
Method: PUT
Parameters
{ "product_key" : "instagram-hashtags", "user_id" : required|integer, "title" : required|string, "language" : required|string, "keywords" : required|string, "creativity" : required|in:0,0.5,1, }
Product key: facebook-headlines
Method: PUT
Parameters
{ "product_key" : "facebook-headlines", "user_id" : required|integer, "title" : required|string, "language" : required|string, "audience" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: google-headlines
Method: PUT
Parameters
{ "product_key" : "google-headlines", "user_id" : required|integer, "title" : required|string, "language" : required|string, "audience" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: google-ads
Method: PUT
Parameters
{ "product_key" : "google-ads", "user_id" : required|integer, "title" : required|string, "language" : required|string, "audience" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: problem-agitate-solution
Method: PUT
Parameters
{ "product_key" : "problem-agitate-solution", "user_id" : required|integer, "title" : required|string, "language" : required|string, "audience" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: academic-essay
Method: PUT
Parameters
{ "product_key" : "academic-essay", "user_id" : required|integer, "title" : required|string, "language" : required|string, "keywords" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: email-welcome
Method: PUT
Parameters
{ "product_key" : "email-welcome", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "keywords" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: email-cold
Method: PUT
Parameters
{ "product_key" : "email-cold", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "keywords" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: email-follow-up
Method: PUT
Parameters
{ "product_key" : "email-follow-up", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "event" : required|string, "keywords" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: creative-stories
Method: PUT
Parameters
{ "product_key" : "creative-stories", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: grammar-checker
Method: PUT
Parameters
{ "product_key" : "grammar-checker", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, }
Product key: 2nd-grader
Method: PUT
Parameters
{ "product_key" : "2nd-grader", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, }
Product key: video-scripts
Method: PUT
Parameters
{ "product_key" : "video-scripts", "user_id" : required|integer, "title" : required|string, "language" : required|string, "description" : required|string, "creativity" : required|in:0,0.5,1, "tone" : required|string|in:neutral,bold,casual,dramatic,excited,formal,funny,informal,luxury,motivational,professional,sarcastic,secretive,witty, }
Product key: amazon-product
Method: PUT
Parameters
{ "product_key" : "amazon-product", "user_id" : required|integer, "title" : required|string, "language" : required|string, "keywords" : required|string, "creativity" : required|in:0,0.5,1, }
Product key: keyword_density
Method: PUT
Parameters
{ "product_key" : "keyword_density", "user_id" : required|integer, "addUrl" : required|string, }
Product key: seo_metatags_analyzer
Method: PUT
Parameters
{ "product_key" : "seo_metatags_analyzer", "user_id" : required|integer, "addUrl" : required|string, }
Product key: seo_youtube_hashtag
Method: PUT
Parameters
{ "user_id" : required|integer, "keyword" : required|string, "language" : required|string, }
Product key: seo_metatag_generator
Method: PUT
Parameters
{ "product_key" : "seo_metatag_generator", "user_id" : required|integer, "title" : required|string, "description" : required|string, "index" : required|string, "follow_links" : required|string, "content_type" : required|string, "language" : required|string, "title" : required|string, "engine_revisit" : required|string, "author" : required|string, }
Product key: trends_wiki
Method: PUT
Parameters
{ "product_key" : "trends_wiki", "user_id" : required|integer, "date" : required|string, "language" : required|string, }
format date: mm/dd/yyyy
Product key: trends_global
Method: PUT
Parameters
{ "product_key" : "trends_global", "user_id" : required|integer, "countries" : required|string, }
Product key: trends_related
Method: PUT
Parameters
{ "product_key" : "trends_related", "user_id" : required|integer, "countries" : required|string, "keyword" : required|string, }
Product key: trends_argument
Method: PUT
Parameters
{ "product_key" : "trends_argument", "user_id" : required|integer, "countries" : required|string, "keyword" : required|string, }
Product key: trends_amazon
Method: PUT
Parameters
{ "product_key" : "trends_amazon", "user_id" : required|integer, "product" : required|string, "domain" : required|string, "categoryId" : required|string, }
Method: GET
Description: does a check of the user’s text orders and returns id, status, title and content if already processed of the orders found, including failed or still unprocessed orders, starting with the most recent.
Endpoint
https://dashboard.contents.com/api/services/orders/show
Parameters
{ "user_id": required|integer, "order_id": optional|integer, "title": optional|string, "website_id": optional|string, "shop_name": optional|string, "language": optional|string (it, en, es,...), "limit": optional|integer|default 10, "offset": optional|integer|default 0 }
Use of the order_id parameter always returns only one result, if any.
Use of the other parameters returns more results, if any.
offset skips a number of orders to be specified.
Api Output
{ "status": "success", "data": [ { "orders": [ { "order_id": , "status": , "title": , "content": }, { "order_id": , "status": , "title": , "content": }, { ... }, ... ] } ] }
Method: GET
Description: does a check of the user’s media orders and returns id, status, title and content if already processed of the orders found, including failed or still unprocessed orders, starting with the most recent.
Endpoint
https://dashboard.contents.com/api/services/media/orders/show
Parameters
{ "user_id": required|integer, "order_id": optional|integer, "title": optional|string, "website_id": optional|string, "shop_name": optional|string, "language": optional|string (it, en, es,...), "limit": optional|integer|default 10, "offset": optional|integer|default 0 }
Use of the order_id parameter always returns only one result, if any.
Use of the other parameters returns more results, if any.
offset skips a number of orders to be specified.
Api Output
{ "status": "success", "data": [ { "orders": [ { "order_id": , "status": , "title": , "content": }, { "order_id": , "status": , "title": , "content": }, { ... }, ... ] } ] }