POST
/control-plane/api/v1/v1/documentation/{organization_id}
Authentication
API Key (BearerAuth)
Header:
Authorization
Path Parameters
organization_idstringrequired
Organization ID
Request Body
Documentation input
Required
audiencestring
descriptionstring
namestringrequired
statusobject
Status is optional. When omitted the doc is created as "pending" (the wizard fills it in via the AI generation flow). Trusted callers that hand-author or import an already-built doc can pass "generated" to skip the pending state.
Example:
{
"audience": "public",
"description": "string",
"name": "string",
"status": {}
}Responses
201
Created
Response Fields:
audience(string)config(object)created_at(string)description(string)has_pending_changes(boolean)id(string)name(string)organization_id(string)published_at(string)slug(string)status(string)updated_at(string)version_selector_enabled(boolean)version_selector_position(string)
Example:
{
"audience": "public",
"config": {
"assistant": {
"enabled": true,
"floating": true
},
"favicon_url": "string",
"footer": {
"copyright": "string",
"enabled": true,
"links": [
{
"icon": "...",
"label": "...",
"style": "...",
"url": "..."
}
],
"powered_by_gitdocai": true
},
"kb": {
"enabled": true,
"hero_description": "string",
"hero_placeholder": "string",
"hero_title": "string",
"icon": "string",
"name": "string",
"popular_articles": [
"string"
],
"popular_title": "string",
"search_suggestions": [
"string"
],
"show_categories": true
},
"navbar": [
{
"icon": "string",
"label": "string",
"style": "string",
"url": "string"
}
],
"seo": {
"default_description": "string",
"default_og_image": "string",
"google_analytics_id": "string",
"site_title": "string",
"title_template": "string"
},
"theme": {
"dark": {
"accent_color": "string",
"bg_color": "string",
"logo_url": "string",
"text_color": "string"
},
"default": {},
"font_family": "string",
"heading_font": "string",
"light": {
"accent_color": "string",
"bg_color": "string",
"logo_url": "string",
"text_color": "string"
},
"modes": [
"dark"
],
"preset": {},
"show_name": true
}
},
"created_at": "string",
"description": "string",
"has_pending_changes": true,
"id": "string",
"name": "string",
"organization_id": "string",
"published_at": "string",
"slug": "string",
"status": "pending",
"updated_at": "string",
"version_selector_enabled": true,
"version_selector_position": "navbar_right"
}400
Bad Request
Example:
{
"key": "value"
}401
Unauthorized
Example:
{
"key": "value"
}500
Internal Server Error
Example:
{
"key": "value"
}