Create Manual
curl --request POST \
--url https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"defaultAudience": "<string>",
"bindings": [
{}
]
}
'import requests
url = "https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals"
payload = {
"title": "<string>",
"defaultAudience": "<string>",
"bindings": [{}]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({title: '<string>', defaultAudience: '<string>', bindings: [{}]})
};
fetch('https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'defaultAudience' => '<string>',
'bindings' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"defaultAudience\": \"<string>\",\n \"bindings\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"defaultAudience\": \"<string>\",\n \"bindings\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"defaultAudience\": \"<string>\",\n \"bindings\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyInstructions
Create Manual
Create a manual — a versioned page tree bound to jobs, folders, or work projects.
POST
/
api
/
public
/
v1
/
instructions
/
workspaces
/
{workspaceId}
/
manuals
Create Manual
curl --request POST \
--url https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"defaultAudience": "<string>",
"bindings": [
{}
]
}
'import requests
url = "https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals"
payload = {
"title": "<string>",
"defaultAudience": "<string>",
"bindings": [{}]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({title: '<string>', defaultAudience: '<string>', bindings: [{}]})
};
fetch('https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'defaultAudience' => '<string>',
'bindings' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"defaultAudience\": \"<string>\",\n \"bindings\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"defaultAudience\": \"<string>\",\n \"bindings\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/v1/instructions/workspaces/{workspaceId}/manuals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"defaultAudience\": \"<string>\",\n \"bindings\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyCreates a manual: a versioned tree of pages with a default read audience and optional bindings to platform surfaces (jobs, folders, work projects).
Requirements:
instructions:write + workspace EDITOR or OWNER + a verified (claimed) account. Supports the Idempotency-Key header (same semantics as Create Workspace).
Request
string
required
The owning workspace.
string
required
Manual title.
string
Default page audience:
ADMIN, CONTRIBUTOR, REVIEWER, or WORKER (workers see the least). Pages can override it.object[]
Where the manual surfaces:
{kind: "JOB" | "FOLDER" | "WORK_PROJECT", targetId, precedence}.Response
Returns201 with manual (the summary shape) and optional idempotentReplay.⌘I