Skip to content
em sa em sa

Request AI revision of a section

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

Queues a revision request for the specified section. 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 required

Section titled “Request Body required ”
Media type application/json
RevisionRequest

Request body for starting a revision.

object
instructions
required
Instructions

User’s revision instructions/feedback

string
>= 10 characters <= 2000 characters
rating
Rating

Quality rating (1=poor, 5=excellent). Default 3 = needs improvement

integer
default: 3 >= 1 <= 5

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
RevisionResponse

Response for revision operations.

object
status
required
Status
string
section_key
Any of:
string
error
Any of:
string
decision
Any of:
string
Example generated
{
  "status": "example",
  "section_key": "example",
  "error": "example",
  "decision": "example"
}

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