Skip to content
em sa em sa

Get Generation Progress

GET
/api/canvas/{deal_id}/progress
 
curl --request GET \
  --url https://example.com/api/canvas/example/progress \
  --header 'Authorization: Bearer <token>'

Check memo generation progress.

Returns which sections have content in the Store. Used by the frontend to show a progress bar during generation.

Phase 4: RequireViewer — all collaborators can view generation progress.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
GenerationProgressResponse

Response for GET /api/canvas/{deal_id}/progress.

object
populated
required
Populated
integer
total
required
Total
integer
sections
required
Sections
object
key
additional properties
boolean
store_available
required
Store Available
boolean
Example generated
{
  "populated": 1,
  "total": 1,
  "sections": {
    "additionalProperty": true
  },
  "store_available": true
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}