Skip to content
em sa em sa

Preview pitch deck content (no Gamma API call)

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

Builds structured slide content for review before generating.

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:
IPDeckModeRequest

Optional body for POST /ip/generate-deck and POST /ip/preview-deck.

object
deck_mode
Deck Mode
string
default: detailed
Allowed values: pitch detailed

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
IPDeckContentResponse

Response for pitch deck content generation (preview only).

object
success
required
Success
boolean
input_text
Any of:
string
deal_type
Any of:
string
deal_type_raw
Any of:
string
deal_type_unknown
Deal Type Unknown
boolean
slide_count
Slide Count
integer
0
slides_dropped
Slides Dropped
Array<string>
default:
sparse_data
Sparse Data
boolean
completeness_report
Any of:
object
key
additional properties
any
gamma_params
Any of:
object
key
additional properties
any
deck_mode
Any of:
string
error
Any of:
string
Example 
{
  "deal_type_unknown": false,
  "slide_count": 0,
  "slides_dropped": [],
  "sparse_data": false
}

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