Starts an asynchronous publish. Returns 202 immediately with the job state; poll /publish/status to see when it finishes.
POST
/control-plane/api/v1/documentation/{organization_id}/{documentation_id}/publish
Authentication
API Key (BearerAuth)
Header:
Authorization
Path Parameters
organization_idstringrequired
Organization ID
documentation_idstringrequired
Documentation ID
Request Body
Publish request with message
Required
messagestring
Example:
{
"message": "string"
}Responses
202
Job accepted
Response Fields:
message(string)started_at(string)state(string): "in_progress"
Example:
{
"message": "string",
"started_at": "string",
"state": "string"
}400
Bad request
Example:
{
"key": "value"
}403
Forbidden - insufficient permissions
Example:
{
"key": "value"
}404
Documentation not found
Example:
{
"key": "value"
}409
A publish is already in progress
Example:
{
"key": "value"
}500
Internal server error
Example:
{
"key": "value"
}