Skip to content
em sa em sa

Regenerate an AI-generated section

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

Queues a full re-generation of the specified section from the latest deal data. Progress is broadcast via WebSocket.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string
section_key
required
Section Key
string

Request Body

Section titled “Request Body ”
Media type application/json
RegenerationRequest

Request body for section regeneration.

object
instructions
Instructions

Optional custom instructions for regeneration. When empty, a standard regeneration prompt is used.

string
"" <= 2000 characters

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Successful Response

Media type application/json
RegenerationResponse

Response for section regeneration.

object
status
required
Status
string
section_key
required
Section Key
string
state
required
State
string
estimated_seconds
Estimated Seconds
integer
default: 60
Example 
{
  "estimated_seconds": 60
}

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