- Getting started
- CREDIT ENDPOINTS
- GENERATE ENDPOINTS
- GETText generation rules and limits
- GETAvailable text generation tones
- GETText generation styles
- GETTarget audiences for text generation
- GETAvailable text types for generation
- GETText generation history
- GETStatus of generated texts
- GETGenerated text for multiple records
- GETActive generation requests
- GETDetails of a specific generation request
- POSTText generation
- POSTCancel a bulk generation request
- POSTUpdate generated text fields
- IMAGE ENDPOINTS
- KEYWORDS ENDPOINTS
- GETKeyword optimization data
- POSTOptimize keywords for text
- DELETEKeyword optimization
- PUTKeyword optimization
- GETKeyword optimization list
- PUTKeyword optimization data
- DELETERanking keywords
- PUTKeyword optimization pipelines
- GETKeyword state
- POSTKeyword pipeline
- DELETEKeyword pipeline
- POSTRestore keyword pipeline
- POSTAdd triggers to keyword pipeline
- POSTAdd triggers to a specific keyword pipeline
- POSTLock a specific keyword pipeline
- POSTUnlock a specific keyword pipeline
- GETPipeline snapshots
- PUTUpdate or create a snapshot
- POSTAdd manual keywords
- GETManual keywords
- REVIEW ENDPOINTS
- SUGGESTION ENDPOINTS
Get text generation rules and limits
get
/text/Generate/Rules
This method retrieves a list of rules and limits for generating text, including maximum lengths for names, tones, styles, audience types, and various other parameters related to text generation. These rules help ensure that text generation requests conform to the supported configurations.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Response
200
304
401
500
//This status is returned when the rules for text generation are successfully retrieved.
//This status is returned if the rules for text generation have not changed and can be retrieved from a cache.
//This status is returned if the API key is missing or invalid.
//The server encountered an error when processing the request.
Parameter Name | Type | Description |
---|---|---|
maxNameLength | integer | The maximum allowed length for names. |
maxCustomToneLength | integer | The maximum allowed length for custom tones. |
maxCustomStyleLength | integer | The maximum allowed length for custom styles. |
maxCustomAudienceLength | integer | The maximum allowed length for custom audience specifications. |
maxOtherDetailsLength | integer | The maximum allowed length for other details. |
maxAttributes | integer | The maximum number of attributes allowed per request. |
maxAttributeValueLength | integer | The maximum length allowed for attribute values. |
maxKeywords | integer | The maximum number of keywords allowed per request. |
maxKeywordLength | integer | The maximum length allowed for a single keyword. |
minOutputWords | integer | The minimum number of words required in the generated text. |
maxOutputWords | integer | The maximum number of words allowed in the generated text. |
maxPageTitleLength | integer | The maximum allowed length for page titles. |
referenceTextTypes | array of strings | A list of reference text types that can be used. |
rewriteTextTypes | array of strings | A list of text types that can be rewritten. |
maxReferenceTextPageTitleLength | integer | The maximum length allowed for reference text page titles. |
maxReferenceTextPageDescriptionLength | integer | The maximum length allowed for reference text page descriptions. |
maxReferenceTextLength | integer | The maximum length allowed for reference text. |
additionalReferenceTextLength | integer | Additional length allowed for reference text. |
maxImageAltTextPerRequest | integer | The maximum number of image alt texts allowed per request. |
maxRepresentativeProducts | integer | The maximum number of representative products allowed per request. |