Appearance
planner
21 endpoints.
GET /api/v1/planner/bootstrap
Bootstrap
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Bootstrap Api V1 Planner Bootstrap Get"
}GET /api/v1/planner/plans
List Plans
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response List Plans Api V1 Planner Plans Get"
}GET /api/v1/planner/plan
Get Plan
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
plan_id | query | yes | integer |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Get Plan Api V1 Planner Plan Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/create
Create
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Create Api V1 Planner Create Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/generate
Generate
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Generate Api V1 Planner Generate Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/chat
Chat
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Chat Api V1 Planner Chat Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/rewrite
Rewrite
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Rewrite Api V1 Planner Rewrite Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/save
Save
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Save Api V1 Planner Save Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/delete
Delete
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Delete Api V1 Planner Delete Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/planner/pdf
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
plan_id | query | yes | integer |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/scan
Scan
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Scan Api V1 Planner Scan Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/planner/company
Company Plan
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
company_id | query | no |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Company Plan Api V1 Planner Company Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/company/create
Company Create
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Company Create Api V1 Planner Company Create Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/company/write
Company Write
Write one section of the company plan, or rewrite it when it exists.
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Company Write Api V1 Planner Company Write Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/company/write-all
Company Write All
Queue every missing section and write them on the server, one by one.
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Company Write All Api V1 Planner Company Write All Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/company/update
Company Update
Update the business plan from its Vision (the button on the Vision page).
Owner, 2026-10-25: "there must be an update business plan button on the vision page" - after editing the vision or mission (2026-10-24: "i don't want to redo tasks that are done already, those tasks must be integrated into the new plan"). Editing the Vision does not rewrite anything by itself (it has no Suggestions), so this queues the Strategy & Action Plan - where every vision goal gets its work - on the same server-side job as Write the plan. The writer reads the new Vision and the live progress block, so finished work is fitted to the goals as they now stand. Tasks are not touched: Create Project on that section stays a separate click.
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Company Update Api V1 Planner Company Update Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/company/write-all/stop
Company Write All Stop
Stop after the section being written.
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Company Write All Stop Api V1 Planner Company Write All Stop Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/company/action-tasks
Company Action Tasks
Expand the action plan (60 days; Telecloud's 30) into detailed tasks (not stored).
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Company Action Tasks Api V1 Planner Company Action Tasks Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/company/to-project
Company To Project
Create the Nova Projects project from the confirmed tasks.
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Company To Project Api V1 Planner Company To Project Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/planner/company/to-projects-all
Company To Projects All
Copy the action plan (60 days since 2026-10-10) to Nova Projects in one go.
Owner, 2026-10-10: "one button to copy all action plans to the nova projects". The same two steps as the modal - expand, then create - with no review: the projects start today, unassigned tasks go to Nova.
Owner, 2026-10-10: "change to create project ... it must clear existing projects, except handovers before creating" - once every plan has been expanded (so a failed AI turn clears nothing), each project on the site is soft-deleted with its tasklists and their cards, except the Nova Hand-offs project the agents' hand-offs live on; then the new ones are made.
It runs in the background and the call returns at once: expanding both plans takes longer than the proxy's 600s on /api/, and the request's own sessions would sit idle past the database's 5-minute transaction limit. A failure lands in the plan's job error, which the planner shows.
Request body
json
{
"additionalProperties": true,
"type": "object",
"title": "Payload"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Company To Projects All Api V1 Planner Company To Projects All Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/planner/company/progress
Company Progress
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
plan_id | query | yes | integer |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Company Progress Api V1 Planner Company Progress Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}