Create a blank document or one from a template

POST

/v1/home/new

curl --request POST \
  --url https://shareout.site/v1/home/new \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "template": "blank", "lang": "en" }'

• Production

The Studio “New” menu’s no-AI path. Creates a private HTML document owned by the caller — blank or from a simple template (report, meeting notes, proposal) — and returns where to open it. Inside a workspace (subdomain or workspace query) the caller must be an internal member. Counts toward the daily publish limit and the storage cap. Agent (sot_) tokens are refused.

Authorizations

• bearerAuth

Parameters

Query Parameters

workspace

string

Workspace id (ignored on a workspace subdomain, which pins it).

Request Body

Media typeapplication/json

object

template

string

default: blank

Allowed values: blank report meeting proposal

lang

Language of the document’s title and headings.

string

default: en

Allowed values: en es

Responses

200

Created

Media typeapplication/json

object

ok

boolean

artifactId

string

slug

string

name

string

Example^generated

{
  "ok": true,
  "artifactId": "example",
  "slug": "example",
  "name": "example"
}

400

Invalid request

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}

401

Authentication required

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}

403

Access denied

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}

413

Storage limit reached

429

Daily publish limit reached