{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8d6fc249-1577-4c6a-b63c-8b6ab7a2af70","name":"TextCortex AI - HemingwAI V3","description":"pyTextCortex's hemingwAI API endpoint documentation\n\nGenerating content using the TextCortex Enterprise Text Generation API is as easy as following these 4 steps:\n\n- [Signup for the TextCortex Hemingwai API](https://app.textcortex.com/user/signup?registration_source=api-documentation)\n- [Go to API Key section and copy your key.](https://app.textcortex.com/user/dashboard/settings/api-key)\n- Make a POST request to [https://api.textcortex.com/hemingwai/generate_text_v3/](https://api.textcortex.com/hemingwai/generate_text_v3/)\n    \n\nTo shorten your development and integration cycle, we have published packages you can install with the following commands:\n\nTo install the textcortex python package, just run this in your terminal:\n\n``` python\npip install textcortex\n\n```\n\n# Authentication\n\nAfter the signup is complete, rest is easy. Just copy your API key from the interface\n\n\\* [Go to API Key section and copy your key.](https://app.textcortex.com/user/dashboard/settings/api-key)  \n\\* With each request send your API key inside `api_key` field\n\nThat's it!\n\n## Supported Text Generation Types\n\n### Copywriting API:\n\nhemingwAI Copywriting API is a collection of text generation features that are used for automating most of the work of a copywriter.\n\n\\* Paraphrase - Rewrite a given sentence without changing its meaning  \n\\* Blog body - Generate a blog article based on a title and keywords  \n\\* Product Descriptions - Generate Product descriptions  \n\\* Autocomplete - Generates rest of the text by looking at the previous entries  \n\\* Blog title - Generate an engaging blog title based on keywords and blog description  \n\\* Blog outlines - Generate sections of a blog post so that you can build well structured article  \n\\* Instagram captions - Generate an instagram caption based on product and audience  \n\\* Youtube descriptions - Generate youtube descriptions based on the video title and audience  \n\\* Video Titles - Generate video titles based on few inputs about the video  \n\\* Ads Tagline - Generate ad tagline based on inputs such as the product and audience  \n\\* Ads Copy - Generate complete ad copies based on the product and audience\n\n### Email API:\n\nhemingwAI Email API is a collection of text generation features that is focused on automating email writing.\n\n\\* Customer Call Request Mail - Create cold outreach emails for reaching new prospective clients  \n\\* Customer Support Email - Generate customer support emails based on a summary  \n\\* Email First Line - Generate a single opening line for an email using subject and audience type  \n\\* Email Subject - Generate email subejcts based on audience and context  \n\\* Bullet to Email - Generate emails based on a few bullet point  \n\\* General Email - Generate a generic email based on few inputs\n\n## Available Fields\n\nHere is a detailed list of fields.\n\n| **Fields** | **Values** | **Description** |\n| --- | --- | --- |\n| **template_name** | \"paraphrase\", \"auto_complete\", \"blog_body\", \"product_descriptions\", \"blog_title\", \"blog_outline\", \"instagram_caption\", \"youtube_description\", \"video_captions\", \"video_titles\", \"customer_call_request\", \"email_first_line\"... | Template name defines the type of text to be produced. Each of the template have different set of inputs therefore check specific examples. |\n| **prompt** | JSON | Each of the template have a different kind of input therefore you need to check what kind of fields exists for a specific template type. |\n| **temperature** | Between 0 and 1. | This parameter sets how creative resulting text will be. Default is 0.65 |\n| **n_gen** | Between 1 and 5 | Defines how many alternatives from this text will be returned. For paraphrasing, minimum should be 2.  <br>  <br>Maximum is 5 |\n| **source_language** | \"auto\" for sensing the language automatically, \"en\" for English, and for other languages check ISO 639-1 language format | Defines the language of the input language. According to that automatically translates the output. |\n| **token_count** | 10-300 defines the maximum amount of words that can be returned | Max word count. |\n| **api_key** | string | Your API Key that makes it possible to make requests. |\n\n### Example JSON Payload For Rewriting a Sentence:\n\n``` json\n{\n    \"template_name\": \"paraphrase\",\n    \"prompt\": {\n        \"original_sentence\": \"It was a great day at cortex HQ.\"\n    },\n    \"temperature\": 1.5,\n    \"token_count\": 20,\n    \"n_gen\": 4,\n    \"source_language\": \"en\",\n    \"api_key\": \"YOUR_API_KEY\"\n}\n\n```\n\n# Rate limit\n\nEndpoints are rate limited, please make sure that you are not sending more than 10 requests per second. [If you need more requests, please fill out this form first.](https://tally.so/r/meqQVo)\n\n# Text Generation Examples:","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"936254","team":951446,"collectionId":"8d6fc249-1577-4c6a-b63c-8b6ab7a2af70","publishedId":"2s83tCLYi9","public":true,"publicUrl":"https://documenter-api.postman.tech/view/936254/2s83tCLYi9","privateUrl":"https://go.postman.co/documentation/936254-8d6fc249-1577-4c6a-b63c-8b6ab7a2af70","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2022-10-05T16:56:37.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/738404b046de887744ee6f4c4f22a2d1ab784410f8dc5e2d6ac04741d01adb44","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s83tCLYi9"}