Create a reoptimization brief and start pipeline

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

opportunityPageUrl*string

URL of the page to optimize

topQueries*array<>

Top queries from GSC

targetKeywords*array<string>

Selected target keywords

market?string

Target market code

Default"us"

language?string

Content language code

Default"en"

mode?string

Pipeline mode. full = SERP-based 7-step reoptimization; structural = lighter GEO refresh (dates, TL;DR, FAQ, comparison table) with no SERP work.

Default"full"

Value in"full" | "structural"

autoMode?boolean

When true, the brief auto-applies ALL recommendations and factual checks the moment the pipeline completes — no human review. Works with either mode. Best-effort: it consumes the configured CONTENT_GENERATION credit cost per recommendation applied, but if that credit check or the queue enqueue fails the brief is left at completed for manual optimize (it is not guaranteed to auto-optimize).

Defaultfalse

Response Body

`application/json`

curl -X POST "https://example.com/domains/string/content-studio-v2/reoptimization-briefs" \  -H "Content-Type: application/json" \  -d '{    "opportunityPageUrl": "https://example.com/blog/my-article",    "topQueries": [      {        "query": "best running shoes for beginners",        "clicks": 320,        "impressions": 12500,        "ctr": 0.026,        "position": 8.4      }    ],    "targetKeywords": [      "best running shoes",      "running shoes for flat feet"    ]  }'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "opportunityPageUrl": "https://nike.com/air-max",
  "status": "completed",
  "source": "gsc",
  "mode": "full",
  "autoMode": false,
  "targetKeywords": [
    "best running shoes",
    "running shoes for flat feet"
  ],
  "language": "en",
  "currentStep": 8,
  "totalSteps": 8,
  "currentStepName": "generateBrief",
  "errorMessage": "Page crawl returned 404",
  "createdAt": "2026-05-25T10:30:00.000Z",
  "completedAt": "2026-05-25T10:35:00.000Z"
}

Empty

Create a reoptimization brief and start pipeline

Authorization

Path Parameters

Request Body

Response Body

`application/json`

Create a reoptimization brief and start pipeline

Authorization

Path Parameters

Request Body

Response Body

`application/json`

Create a reoptimization brief and start pipeline

201application/json

403

Create a reoptimization brief and start pipeline

201application/json

403

`application/json`

`application/json`