Skip to content
em sa em sa

Digitize an image element to editable content

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

Convert a chart, table, or graph image to structured editable content.

Streams SSE events with stage updates followed by the final digitized result. Stages: analyzing → extracting → formatting → result payload.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string
element_id
required
Element Id
string

Request Body required

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

Request body for image digitization.

object
image_url
required
Image Url
string
<= 2048 characters
element_type
required
Element Type
string
Example generated
{
  "image_url": "example",
  "element_type": "example"
}

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