Skip to main content
POST
Create a workspace
Creates a workspace in DRAFT. Nothing else happens: no domain analysis, no description generation and no billable run. Configure it, then activate it with Update a workspace.
Requires any active API key on a Business, Agency Business or Enterprise plan. Existing keys work without rotation. See Writing data.
string
required
Bearer token. Example: Bearer qw-api-xxx
string
required
Unique key for this creation. Replaying it returns the original workspace instead of creating a duplicate.
string
required
Display name, up to 120 characters.
string
required
Valid public hostname, up to 253 characters, without scheme, port or path. Example: acme.com.
string
Optional description. Left empty if omitted; nothing is generated for you.
string
Two-letter language code. Defaults to FR.
string
ISO 3166-1 alpha-2 country code. Defaults to FR. Any other value returns 400 INVALID_REQUEST.

Response

Returns 201 with a Location header and the workspace ETag.
string
Opaque workspace identifier
string
Always DRAFT for a newly created workspace
number
Current version, used as the If-Match value for later updates
string | null
Workspace URL, or null when none is set
string[]
Workspace country catalog. The default country comes first
boolean
Whether Qwairy detects competitors automatically in answers
string
REGISTRABLE, EXACT_HOST or AUTO. A read can return AUTO; a write cannot set it
The response also returns name, domain, description, languageCode, countryCode, lifecycleVersion, createdAt and updatedAt.

Synthetic request

Synthetic response

Errors