Apply a brush to multiple sections

POST

/api/canvas/{deal_id}/batch-transform

curl --request POST \
  --url https://example.com/api/canvas/example/batch-transform \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "transform_type": "example", "section_keys": [ "example" ], "scope": "section" }'

Streams batch brush results via Server-Sent Events. Events: batch_started, section_started, section_complete, section_failed, section_skipped, batch_done.

Authorizations

• HTTPBearer

Parameters

Path Parameters

deal_id

required

Deal Id

string

Request Body ^required

Media type application/json

BatchTransformRequest

Request body for batch brush application across multiple sections.

object

transform_type

required

Transform Type

Brush key: [‘audit_section’, ‘enrich’, ‘improve’, ‘market_context’, ‘quantify’, ‘source_it’]

string

section_keys

required

Section Keys

Section keys to apply the brush to (max 15)

Array<string>

>= 1 items <= 15 items

scope

Scope

Brush scope (usually ‘section’ for batch operations)

string

default: section

Responses

200

Successful Response

Media type application/json

Example ^generated

example

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