Skip to main content
POST
Create a page

Authorizations

Authorization
string
header
required

A workspace API key: wdy_live_… / wdy_test_…. Created at POST /workspaces/{tenantId}/keys and shown exactly once.

Body

application/json
name
string

Optional at create (C10): a page can be born as a minimal draft from its kind alone and be named on its settings screen. Publishing does not require a name; the console shows a placeholder for an unnamed draft.

Maximum string length: 80
kind
enum<string>

What the page is (D-47). agent (default) is a conversational page with an agent and editorial; document renders an uploaded markdown body and takes no agent or editorial.

Available options:
agent,
document
agentId
string

The agent that answers on this page. Optional: a draft may leave it unset (auto-assigned when the workspace has exactly one agent), but publishing an agent page requires one. A document page has none.

body
object

The markdown of a document page (D-47), per language. Optional at create (a document draft may start empty; publishing requires the source language); absent for an agent page.

path
string

The address under the workspace host. / is the home page, and exactly one page per workspace has it. Otherwise up to 4 segments of letters, digits and single hyphens (/pymes, /enterprise/latam). Case-insensitive and stored lowercase. Never percent-encoded, never a dot segment. Reserved by the platform (and their whole subtree): admin, api, app, cdn, console, docs, embed, mail, status, storage, well-known, widget, www. Defaults to / when nothing serves the home page yet, and otherwise to a path derived from the name.

Maximum string length: 200
defaultLocale
enum<string>

The language the owner writes this page in (D-44). Must be one the SITE serves; defaults to the project’s source language. Which languages are SERVED is the project’s setting.

Available options:
es,
en
projectId
string

The site (project) this page is created inside. Optional only while the workspace has exactly one; required with several.

Response

id
string
required
name
string
required
kind
enum<string>
required

agent or document (D-47).

Available options:
agent,
document
path
string
required

The address under the site host. / is home.

status
string
required

draft or published.

defaultLocale
enum<string>
required
Available options:
es,
en
editorial
object
required

The owner-written framing (agent page). Empty for a document.

seo
object
required
sitemap
object
required
body
object
required

The markdown of a document page. Empty for an agent page.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
agentId
string

The brain that answers here. Absent for a document page.

projectId
string

The site (project) the page lives in.

publishedAt
string<date-time>