Skip to content
em sa em sa

Generate Investor Packet

POST
/api/canvas/{deal_id}/ip/generate
 
curl --request POST \
  --url https://example.com/api/canvas/example/ip/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "terms": {} }'

Generate a .docx Investor Packet from deal terms and template.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Request Body

Section titled “Request Body ”
Media type application/json
Any of:
IPGenerateRequest

Optional body for POST /ip/generate.

terms carries an IPDealTerms-shaped dict to save before generating; validation of individual fields runs downstream in validate_ip_terms_payload.

object
terms
Any of:
object
key
additional properties
any
Example generated
{
  "terms": {}
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
IPGenerateResponse

Response for IP generation.

object
success
required
Success
boolean
filename
Any of:
string
download_url
Any of:
string
pdf_url
Any of:
string
generation_time_ms
Generation Time Ms
integer
0
error
Any of:
string
warnings
Any of:
Array
coverage_pct
Any of:
number
effective_coverage_pct
Any of:
number
Example 
{
  "generation_time_ms": 0
}

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