Create context image

Uploads a new context image and optionally connects it to text segments.

The connection behavior depends on the connectType parameter:

  • KEY_BASED: Connect the image to specific segments identified by file path and key
  • TEXT_BASED: Connect the image to segments by matching the text content
  • IMAGE_BASED: Use OCR text detection to automatically find and connect matching text segments

When using KEY_BASED or TEXT_BASED, provide the segments array with highlight boxes to indicate where the text appears on the image.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

workspaceUrl

string
required

projectUrl

Body Params
file
required

The image file to upload (multipart form field name: 'file'). Supported formats: PNG, JPG, JPEG, WEBP

request
object
required

Defines how to create and connect the context image

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*