Skip to content
em sa em sa

Batch digitize multiple image elements

POST
/api/canvas/{deal_id}/images/batch-digitize
 
curl --request POST \
  --url https://example.com/api/canvas/example/images/batch-digitize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "elements": [ { "element_id": "example", "element_type": "example", "image_url": "example" } ], "stitch": false }'

Digitize multiple image elements in a single SSE stream.

Each element is processed sequentially. Per-element failures do not abort the batch — a summary event is emitted at the end.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Request Body required

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

Batch digitization request — up to 10 elements in one SSE stream.

object
elements
required
Elements
Array<object>
>= 1 items <= 10 items
BatchDigitizeElement

One element in a batch digitization request.

object
element_id
required
Element Id
string
<= 256 characters
element_type
required
Element Type
string
image_url
required
Image Url
string
<= 2048 characters
stitch
Stitch
boolean

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