How far Nora is with a plan

GEThttps://api.norreach.app/v1/plans/{id}/generation

Nora's progress writing the plan (step of total, her note), and — after POST /plans/{id}/replan — the change asked for and her proposal once it is written.

plans:readOperation id: get_plan_generation

GET/plans/{id}/generation

curl -X GET "https://api.norreach.app/v1/plans/{id}/generation" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

How far Nora is with a plan

{
  "object": "plan_generation",
  "plan_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "status": "generating",
  "step": 3,
  "total": 7,
  "note": "Writing the cards",
  "done": false,
  "failed": false,
  "error": null,
  "replan": null
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope plans:read. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Response

200application/json— How far Nora is with a plan

object"plan_generation"required

plan_idstring (uuid)required

An id (UUID).

statusenumrequired

One of:generatingreviewactivepausedcompletedfailed

stepintegerrequired

totalintegerrequired

notestringrequired

donebooleanrequired

failedbooleanrequired

errorstring | nullrequired

Why the last run stopped, for a person.

replanobject | nullrequired

The last change asked for, and Nora's proposal once it is written.

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
404	`not_found`	That doesn't exist.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/plans/{id}/generation

curl -X GET "https://api.norreach.app/v1/plans/{id}/generation" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

How far Nora is with a plan

{
  "object": "plan_generation",
  "plan_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "status": "generating",
  "step": 3,
  "total": 7,
  "note": "Writing the cards",
  "done": false,
  "failed": false,
  "error": null,
  "replan": null
}