SERP outline

Turn live SERP intent into a writer- and agent-ready page outline. Costs 4 credits.

post/content/serp-outline

Request

  • Base URL: https://www.agentseo.dev/api/v1
  • URL: https://www.agentseo.dev/api/v1/content/serp-outline
  • Auth: API key in header x-api-key

Query parameters

syncboolean

Open a short inline processing window when supported by the endpoint. If the result is not ready yet, the endpoint may still return 202 with a queued payload that includes poll_url, events_url, and retry_after_seconds.

Headers

x-project-idstring

Optional attribution label for grouping usage and jobs by project.

x-workflow-idstring

Optional attribution label for grouping usage and jobs by workflow or agent run.

Request body

keywordstring required
targetstring

Optional target brand, domain, or product to route the outline toward.

locationstring
location_codeinteger

Optional search location code for deterministic geo-targeting.

languagestring
device'desktop' | 'mobile'
outline_depth'brief' | 'standard' | 'detailed'
include_title_optionsboolean

Response

Completed SERP outline workflow with agent_workflow

keywordstring
targetstring nullable
outlineobject
markdown_summarystring

Changes

No recorded changes to this operation across all 1 revision of this API.