- 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
Restore cluster-based pipeline
post
/text/Keywords/Optimization/Pipelines/Restore
This endpoint allows restoring a deleted cluster-based pipeline using the provided parameters and request body. The restored pipeline's details will be included in the response.
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 | The store identifier. Defaults to "default" if not provided. |
type | string, required | Specifies the type of pipeline, which can be either Product or Category. |
recordId | string, required | The Object ID associated with the pipeline. |
languageCode | string, required | Two-letter language code, e.g., en . Default is en . |
triggers | object, optional | Contains additional trigger configurations for the pipeline. |
triggers.additionalProp1 | object, optional | Additional trigger with options, value, action, and text types. |
triggers.additionalProp1.option | string, optional | Trigger option (e.g., None ). |
triggers.additionalProp1.value | integer, optional | Value associated with the trigger. |
triggers.additionalProp1.action | string, optional | Trigger action (e.g., FlagForRewrite ). |
triggers.additionalProp1.textTypes | array, optional | Types of text associated with the trigger. |
Response
200
400
404
500
//The request was successful, and the keyword pipeline has been restored. The response includes the restored pipeline's details.
xxxxxxxxxx
1
{
2
"pipeline": {
3
"id": "string",
4
"name": "string",
5
"date": "2025-01-27T05:22:12.446Z",
6
"autogenerated": true,
7
"locked": true,
8
"keywords": {
9
"additionalProp1": {
10
"keyword": "string",
11
"date": "2025-01-27T05:22:12.446Z",
12
"position": 0,
13
"positionDelta": 0,
14
"positionDate": "2025-01-27T05:22:12.446Z",
15
"searchVolume": 0,
16
"difficulty": 0,
17
"intent": "string",
18
"intentDisplay": "string",
19
"trafficPotential": 0,
20
"serpDate": "2025-01-27T05:22:12.446Z",
21
"isSeed": true,
22
"serpItems": [
23
{
24
"url": "string",
25
"domain": "string",
26
"title": "string",
27
"snippet": "string",
28
"position": 0
29
}
30
]
31
}
32
},
33
"triggers": {
34
"additionalProp1": {
35
"option": "string",
36
"value": 0,
37
"action": "string",
38
"textTypes": [
39
"string"
40
]
41
}
42
},
43
"currentLevel": "string",
44
"currentState": "string"
45
},
46
"availableClustersToRestore": 0
47
}
//The request is invalid due to missing or incorrect fields.
xxxxxxxxxx
1
{
2
"type": "string",
3
"title": "string",
4
"status": 400,
5
"detail": "string",
6
"instance": "string",
7
"additionalProp1": "string",
8
"additionalProp2": "string",
9
"additionalProp3": "string"
10
}
//The specified resource does not exist or cannot be found.
xxxxxxxxxx
1
{
2
"type": "string",
3
"title": "string",
4
"status": 404,
5
"detail": "string",
6
"instance": "string",
7
"additionalProp1": "string",
8
"additionalProp2": "string",
9
"additionalProp3": "string"
10
}
//The server encountered an error when processing the request.
x
1