Content schema plan

Plan JSON-LD schema for a URL or markdown page without a paid provider call. Costs 3 credits.

post/content/schema-plan

Request

  • Base URL: https://www.agentseo.dev/api/v1
  • URL: https://www.agentseo.dev/api/v1/content/schema-plan
  • 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

urlstring uri

Page URL to scrape. Either url or page_markdown is required.

page_markdownstring

Page markdown when a URL is not available.

page_type'auto' | 'article' | 'blog_post' | 'landing_page' | 'product' | 'software' | 'local_business' | 'faq' | 'how_to'
keywordstring

Optional target keyword for context.

targetstring

Optional target brand, domain, or product.

include_jsonldboolean

Response

Completed content schema plan workflow with agent_workflow

keywordstring nullable
targetstring nullable
schema_planobject
markdown_summarystring

Changes

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