---
title: "Generate Schema"
method: POST
path: "/generate-schema"
tags: ["schema"]
---

# Generate Schema

`POST /generate-schema`

## Request

- Base URL: `https://api.xeorank.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.xeorank.com/generate-schema`
- Auth: API key in header `X-Agent-Key`

## Query parameters

- `email` string, nullable

## Headers

- `X-Org-Id` string, nullable

## Request body

- SchemaGenRequest
  - `url` string, required
  - `schema_type` 'faq' | 'organization' | 'article' | 'howto' | 'breadcrumb' | 'localbusiness' | 'auto'
  - `context` object, nullable

## Response `200`

Successful Response

- SchemaGenResponse
  - `url` string, required
  - `schema_type` string, required
  - `jsonld` string, required
  - `html_snippet` string, required
  - `notes` string
  - `grounded` boolean

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/xeorank/apis/seo-intelligence-engine.md) · [All operations](https://skmtc.dev/xeorank/apis/seo-intelligence-engine/llms.txt) · [OpenAPI document](https://skmtc.dev/xeorank/apis/seo-intelligence-engine/revisions/449a3fd73454?raw)