- 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
Update keyword optimization parameters
post
/text/keywords/optimization
This API endpoint is used to update the image used in automatic rewriting.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Content-Type: application/json
Content-Type: application/json
Parameter Name | Type | Description |
---|---|---|
storeId | string, required | Identifies the storefront for the text object. |
type | string, required | Specifies the type of object to optimize, which can be either Product or Category. |
recordId | string, required | Unique identifier of the record for which keywords are optimized. |
languageCode | string, optional | A 2-letter code indicating the language, e.g., "en" . Defaults to "en" if not provided. |
imageId | string, optional | Identifier of the associated image for additional optimization context. |
Example API Request
//https://api-eu.writetext.ai/text/keywords/optimization
Response
200
400
404
500
//The request was successfully processed. The response includes details of the keyword optimization process, such as the optimization status, steps completed, traffic potential, ranking keywords, and generated pipelines.
//This error occurs when the request is improperly formatted or missing required fields.
//This error occurs when the specified resource (e.g., recordId) cannot be located.
//The server encountered an error when processing the request.