Skip to content

Download generated Investor Packet

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

Download the generated .docx Investor Packet file.

Serves the docx from Store blob (persists across Railway restarts).

Phase 4: RequireEditor — editors and owners can download the investor packet. Requires editor access to match the generate endpoint and protect sensitive financial documents from viewer-only accounts.

deal_id
required
Deal Id
string

Successful Response

Media type application/json
Example generated
example

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": {}
}
]
}