- WriteText.ai API Overview
- 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 keyword state
get
/text/Keywords/Optimization/Pipelines/KeywordState
This endpoint retrieves the state of keywords in the optimization pipeline, filtering them based on their current state.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
| Parameter Name | Type | Description |
|---|---|---|
| storeId | string, optional | The store identifier. Defaults to "default" if not provided. |
| type | string, required | Specifies the type of entity, which can be either Product or Category. |
| languageCode | string, optional | Two-letter language code, e.g., en. Default is en. |
| states | array [string], optional | Filters keywords by optimization state. Accepted values are: ForGeneration (ready for text generation), Generated (used to generate text), Published (text published). |
| continuationToken | string, optional | Token used to retrieve the next page of results |
| pageSize | integer, optional | The number of results to return per page. Default is 100. |
Response
200
400
500
//The request was successful, and the state of the keywords was retrieved.
//The request is invalid due to missing or incorrect parameters.
//The server encountered an error when processing the request.