Skip to content
em sa em sa

Generate Suggestions

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

Generate inline AI suggestions for a section’s content.

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
SuggestionRequest
object
content
required
Content
string
max_suggestions
Max Suggestions
integer
default: 5 >= 1 <= 10

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Example generated
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": {}
    }
  ]
}