Blocks

How each block is represented in the API

Below are example representations of all currently supported block types in the API.

Text

{"sentence": "A random sentence"}

Email

{"an_email": "[e-mail]"}

Number

{"a_number": 42}

Date

{"a_date": "2021-01-31"}

Link

{"a_link": "https://example.com"}

Image

{"some_image": "https://example.com/logo.png"}

PDF

{"a_pdf": "https://example.com/file.pdf"}

Embed

{"website": "https://example.com"}

Video

{"a_video": "https://example.com/video.mp4"}

Audio

{"a_song": "https://example.com/song.mp3"}

Binary

{"true_or_false": true}

Single Selection

{"choose_a_color": "red"}

Multiple Selection

{"choose_few_colors": ["red", "blue", "green"]}

Form

{
  "form_sequence": {
    "question_1": true,
    "question_2": "this is a random answer",
    "question_3": "option-2"  
  }
}

Rich Text

{
  "some_text": "This can be **Markdown** or <b>HTML</b> formatted depending on the block's configuration."
}

Text Highlighting

{
  "ner_data": {
    "text": "This is a paragraph of text",
    "entities": [{
      "start": 5,
      "end": 7,
      "category": "verb"
    }]
  }
}

Bounding Boxes

{
  "bounding_boxes_id": {
      "image": "https://i2.wp.com/oohtoday.com/wp-content/uploads/2018/08/formetco-photo-digital-unit-in-canada.jpg?fit=1995%2C1125&ssl=1",
      "objects": [
        {
          "w": 0.274, // 27.4%
          "h": 0.2955, // 29.55%
          "y": 0.1051, // 10.51%
          "x": 0.2067, // 20.67%
          "category": "billboard"
        },
        {
          "w": 0.2244,
          "h": 0.2585,
          "y": 0.5852,
          "x": 0.6571,
          "category": "vehicle"
        }
      ]
    }
}

Coordinates are expressed in relative terms with respect to the image in question to accommodate for responsiveness in terms of users' varying window dimensions and screen resolutions. With that, Bounding Box blocks can change in size without disrupting how past tasks are displayed.

Text Sequence

{
  "sentences": [
    "Foo",
    "Bar"
  ]
}