/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Check Subdomain Availability

Check Subdomain Availability

Check whether a project slug and its docs subdomain are free to use

GET/v1/projects/subdomain-availableTry it
Session token

Check whether a slug can be used for a new project, before you call Create Project. Every project's doc site is served from {slug}-docs.syntext.dev, so slugs are unique across all of Syntext, not just your organization.

Note

Requires a session JWT. Any signed-in user can call it — no organization role is needed. Any plan. API keys are not accepted.

Query Parameters

NameDescription
slug:stringqueryRequired
The slug to check, e.g. acme-api. It is trimmed and lower-cased before the check.

Response

NameDescription
data:object
Show 5 child attributesobject

The response never says which project or organization holds a taken slug.

Response — 200 OK

A taken slug:

An invalid slug is still a 200, with available: false and reason: "invalid".

Note

The result is a snapshot. Someone can take a free slug between this check and your create call, so handle 409 conflict from Create Project as well.

Error Responses

400 Bad Request

Returned when slug is missing or empty.

json
{
"error": {
"code": "validation_error",
"message": "slug query parameter required",
"details": { "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}

401 Unauthorized

Returned when the Authorization header is missing, or the token is invalid or expired (unauthorized), or the session was signed out (session_revoked).

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl "https://api.syntext.dev/v1/projects/subdomain-available?slug=Acme-API" \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200jsonOK
{
"data": {
"slug": "acme-api",
"subdomain": "acme-api-docs",
"hostname": "acme-api-docs.syntext.dev",
"available": true
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext