Get Block Version

curl --request GET \
  --url https://api.retab.com/v1/workflows/blocks/versions/{block_version_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.retab.com/v1/workflows/blocks/versions/{block_version_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.retab.com/v1/workflows/blocks/versions/{block_version_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.retab.com/v1/workflows/blocks/versions/{block_version_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.retab.com/v1/workflows/blocks/versions/{block_version_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.retab.com/v1/workflows/blocks/versions/{block_version_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "block_id": "<string>",
  "workflow_id": "<string>",
  "workflow_version_id": "<string>",
  "type": "start_document",
  "created_at": "2023-11-07T05:31:56Z",
  "label": "",
  "position_x": 0,
  "position_y": 0,
  "width": 123,
  "height": 123,
  "parent_id": "<string>",
  "config": {},
  "resolved_schemas": {},
  "config_hash": ""
}

{
  "detail": []
}

GET

workflows

blocks

versions

{block_version_id}

Get Block Version

curl --request GET \
  --url https://api.retab.com/v1/workflows/blocks/versions/{block_version_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.retab.com/v1/workflows/blocks/versions/{block_version_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.retab.com/v1/workflows/blocks/versions/{block_version_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.retab.com/v1/workflows/blocks/versions/{block_version_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.retab.com/v1/workflows/blocks/versions/{block_version_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.retab.com/v1/workflows/blocks/versions/{block_version_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "block_id": "<string>",
  "workflow_id": "<string>",
  "workflow_version_id": "<string>",
  "type": "start_document",
  "created_at": "2023-11-07T05:31:56Z",
  "label": "",
  "position_x": 0,
  "position_y": 0,
  "width": 123,
  "height": 123,
  "parent_id": "<string>",
  "config": {},
  "resolved_schemas": {},
  "config_hash": ""
}

{
  "detail": []
}

Fetch one immutable workflow block version.

Python

block_version_id = "bkv_abc123"
print(block_version_id)

TypeScript

const blockVersionId = "bkv_abc123";
console.log(blockVersionId);

blockVersionID := "bkv_abc123"
_ = blockVersionID

Java

String blockVersionId = "bkv_abc123";
System.out.println(blockVersionId);

cURL

curl "https://api.retab.com/v1/workflows/blocks/versions/bkv_abc123?workflow_id=wf_abc123" \
  -H "Authorization: Bearer $RETAB_API_KEY"

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

block_version_id

string

required

Response

Successful Response

Public block version resource without tenant or storage-only fields.

string

required

Public content-addressed block version ID

block_id

string

required

Stable logical block ID

workflow_id

string

required

Source workflow ID

workflow_version_id

string

required

Workflow version this block version belongs to

type

enum<string>

required

Available options:

start_document,

start_json,

note,

parse,

edit,

extract,

split,

classifier,

conditional,

api_call,

function,

while_loop,

for_each,

merge_dicts,

while_loop_sentinel_start,

while_loop_sentinel_end,

for_each_sentinel_start,

for_each_sentinel_end

created_at

string<date-time>

required

label

string

default:""

position_x

number

default:0

position_y

number

default:0

width

number | null

height

number | null

parent_id

string | null

config

Config · object | null

resolved_schemas

Resolved Schemas · object | null

config_hash

string

default:""

Stable SHA-256 hash of the executable block config