Start a human review task

curl --request POST \
  --url https://flows.super.ai/api/human-review-tasks/{task_id}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://flows.super.ai/api/human-review-tasks/{task_id}/start"

headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://flows.super.ai/api/human-review-tasks/{task_id}/start', 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://flows.super.ai/api/human-review-tasks/{task_id}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-API-Key: <api-key>"
  ],
]);

$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://flows.super.ai/api/human-review-tasks/{task_id}/start"

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://flows.super.ai/api/human-review-tasks/{task_id}/start")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/human-review-tasks/{task_id}/start")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "flow_execution_id": "550e8400-e29b-41d4-a716-446655440000",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified_by": "<string>",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "source_task_execution_idx": 0,
  "source_task_name": "process_document",
  "status": "pending",
  "target_task_execution_idx": 0,
  "target_task_name": "receive_file",
  "updated_at": "2023-11-07T05:31:56Z",
  "completed_at": "2024-01-01T00:00:00Z",
  "completed_by": "550e8400-e29b-41d4-a716-446655440000",
  "instructions": "Please review the document and verify all dates are correct.",
  "review_result": true,
  "reviewed_output": {
    "comments": "All dates are correct.",
    "verified": true
  },
  "task_metadata": {
    "priority": "high",
    "source": "api"
  }
}

human-review-tasks

Start a human review task

Start a human review task.

Marks the task as in progress for the current user. This endpoint:

Creates an in-progress record linking the user to the task
Changes task status from ‘pending’ to ‘in_progress’ (if it’s pending)
Returns 409 if the task is already completed
Can be called multiple times for the same user (idempotent)
Creates a timeout schedule to automatically unstart the task if it remains IN_PROGRESS beyond the configured timeout

Context:

Only authenticated users can start tasks
Updates assignment status to ‘in_progress’ and sets started_at timestamp
Updates task status if currently pending
Organization ID is automatically set from the current user’s context

Use Cases:

User begins working on an assigned review task
Track which users are currently working on which tasks
Prevent starting already completed tasks

Related Endpoints:

GET /human-review-tasks - List all assigned tasks
POST /human-review-tasks - Create a new review task

POST

api

human-review-tasks

{task_id}

start

Start a human review task

curl --request POST \
  --url https://flows.super.ai/api/human-review-tasks/{task_id}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://flows.super.ai/api/human-review-tasks/{task_id}/start"

headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://flows.super.ai/api/human-review-tasks/{task_id}/start', 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://flows.super.ai/api/human-review-tasks/{task_id}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-API-Key: <api-key>"
  ],
]);

$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://flows.super.ai/api/human-review-tasks/{task_id}/start"

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://flows.super.ai/api/human-review-tasks/{task_id}/start")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/human-review-tasks/{task_id}/start")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "flow_execution_id": "550e8400-e29b-41d4-a716-446655440000",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified_by": "<string>",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "source_task_execution_idx": 0,
  "source_task_name": "process_document",
  "status": "pending",
  "target_task_execution_idx": 0,
  "target_task_name": "receive_file",
  "updated_at": "2023-11-07T05:31:56Z",
  "completed_at": "2024-01-01T00:00:00Z",
  "completed_by": "550e8400-e29b-41d4-a716-446655440000",
  "instructions": "Please review the document and verify all dates are correct.",
  "review_result": true,
  "reviewed_output": {
    "comments": "All dates are correct.",
    "verified": true
  },
  "task_metadata": {
    "priority": "high",
    "source": "api"
  }
}

Authorizations

X-API-Key

string

header

required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

X-API-Key: saf_1234567890

Authorization

string

header

required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Path Parameters

task_id

string

required

Response

Human review task started successfully

Response model for human review task operations.

created_at

string<date-time>

required

flow_execution_id

string<uuid>

required

UUID of the flow execution this task is associated with.

Example:

"550e8400-e29b-41d4-a716-446655440000"

string<uuid>

required

modified_by

string

required

organization_id

string<uuid>

required

UUID of the organization this task belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

source_task_execution_idx

integer

required

Index of the source task execution that created this review.

Example:

0

source_task_name

string

required

Name of the source task that created this review.

Example:

"process_document"

status

string

required

Status of the task. Valid values: 'pending', 'in_progress', 'completed'.

Example:

"pending"

target_task_execution_idx

integer

required

Index of the target task execution.

Example:

0

target_task_name

string

required

Name of the target task being reviewed.

Example:

"receive_file"

updated_at

string<date-time>

required

completed_at

string<date-time> | null

Timestamp when the task was completed. Null for not completed tasks.

Example:

"2024-01-01T00:00:00Z"

completed_by

string<uuid> | null

UUID of the user who completed this task. Null for not completed tasks.

Example:

"550e8400-e29b-41d4-a716-446655440000"

instructions

string | null

Instructions for the human reviewer on how to complete this task.

Example:

"Please review the document and verify all dates are correct."

review_result

boolean | null

Review result: True for correct, False for incorrect, null for not yet finished.

Example:

true

reviewed_output

Reviewed Output · object | null

JSON output of the completed review. Null for not yet completed tasks.

Example:

{
  "comments": "All dates are correct.",
  "verified": true
}

task_metadata

Task Metadata · object | null

Additional metadata associated with the human review task.

Example:

{ "priority": "high", "source": "api" }

Complete a human review task Unstart a human review task assignment