Opportunity implementation brief

Turn one selected keyword or page opportunity into an implementation-ready brief. Costs 10 credits base, or 12 credits with competitor outlines.

post/opportunities/brief

Request

  • Base URL: https://www.agentseo.dev/api/v1
  • URL: https://www.agentseo.dev/api/v1/opportunities/brief
  • 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 required

Target domain or URL.

page_urlstring uri
locationstring
location_codeinteger

Optional search location code for deterministic geo-targeting.

languagestring
opportunity_type'quick_win' | 'content_refresh' | 'ai_overview_opportunity' | 'featured_snippet_opportunity' | 'commercial_intent_opportunity' | 'lost_keyword_recovery' | 'competitor_gap'
current_rankinteger
include_competitor_outlinesboolean

Scrapes top competitor outlines and increases request cost by 2 credits.

Response

Completed opportunity brief with implementation guidance and agent_workflow

keywordstring
targetstring
page_urlstring nullable
priority'high' | 'medium' | 'low'
implementation_briefobject
competitor_outlinesobject[]
markdown_summarystring

Changes

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