Skip to main content
GET
Get Content Editor

Authorizations

API-KEY
string
header
required

Path Parameters

workspace_id
integer
required
Required range: x >= 1
Example:

123

id
integer
required
Required range: x >= 1
Example:

123

Response

Content Editor detail

inserted_at
string<date-time>
required
Example:

"2024-04-12T15:23:45Z"

ai_article
AiArticle · object | null
required

Active AI article. null if no AI article has been generated for the Content Editor.

ai_search_guidelines
AiSearchGuidelinesStatus · object | null
required

AI Search guidelines state. null when no AI Search guidelines exist for the Content Editor (e.g. created before the workflow existed) — distinct from {status: "executing"} (generation in progress).

auto_optimize
AutoOptimizeStatus · object | null
required

Latest Auto-Optimize job state. null when no Auto-Optimize has ever been run on this Content Editor.

content_score
ContentScore · object
required
created_by
string | null
required
device
enum<string>
required
Available options:
mobile,
desktop
Example:

"mobile"

id
integer
required
Required range: x >= 1
Example:

123

location
string
required

Location; get the list of supported locations from /api/v1/locations (no auth required)

Example:

"United States"

main_keyword
string
required
Example:

"seo tools"

outline
OutlineStatus · object | null
required

Outline state. null when no outline exists for the Content Editor — distinct from {status: "scheduled"} (generation in progress).

secondary_keywords
string[]
required
Example:
seo_guidelines
SeoGuidelinesStatus · object | null
required

SEO guidelines state. null when no SEO guidelines exist for the Content Editor — distinct from {status: "executing"} (generation in progress).

state
enum<string>
required
Available options:
completed,
executing,
failed,
scheduled
Example:

"completed"

workspace_id
integer
required
Required range: x >= 1
Example:

123

updated_at
string<date-time>
Example:

"2024-06-01T09:17:33Z"

custom_template_id
integer | null

Workspace-level custom template ID. Mutually exclusive with surfer_template.

Required range: x >= 1
custom_voice_id
integer | null
Required range: x >= 1
Example:

123

error
ErrorDetails · object | null
import_content_url
string | null
Example:

"https://example.com/article"

surfer_template
enum<string> | null

Surfer template preset. Mutually exclusive with custom_template_id.

Available options:
blog_post,
category_description,
product_description,
comparison,
listicle,
landing_page,
local_business,
llm_optimized_article
Example:

"blog_post"

target_word_count
integer | null
Example:

2000

use_brand_knowledge
boolean

Whether workspace brand knowledge is enabled for this Content Editor.

Example:

true

custom_instructions
string | null
Example:

"Write from perspective of a senior developer"

meta_description
string | null

Draft meta description.

Example:

"A curated list of the top SEO tools for 2025."

meta_title
string | null

Draft meta title.

Example:

"Best SEO Tools in 2025"

notes
string | null
Example:

"Draft for Q2 campaign"