v1

latestOpenAPI 3.0.42026-08-04342835917.6 KB

Flow

Retrieves a flow by its ID.

get/flow/{flowId}

Path parameters

flowIdstring required

The ID of the flow to retrieve.

Response

_t'RankingFlow' required

idstring required

The unique identifier of the flow.

namestring required

The name of the flow.

campaignIdstring required

The ID of the campaign associated with this flow.

flowItemCountinteger required

The total number of items that have been added to this flow. Incremented atomically on each item creation.

targetResponseCountinteger nullable required

Target average response count per completed item. Enables PID-based automatic rate control when set. Null disables PID.

pidProportionalGainnumber double required

PID proportional gain. Controls how strongly the rate reacts to the current error between target and actual response counts.

pidIntegralGainnumber double required

PID integral gain. Eliminates steady-state error by accumulating error over time. Includes anti-windup clamping.

pidDerivativeGainnumber double required

PID derivative gain. Provides damping by reacting to the rate of change of the error, helping prevent overshoot.

pidOutputOffsetnumber double required

Constant offset added to the PID output before clamping, shifting the controller's operating point so the P/I/D terms trim around a non-zero baseline.

pidMinSessionsPerMinuteinteger required

Minimum sessions per minute the PID controller can set. Prevents the rate from dropping to zero.

pidMaxSessionsPerMinuteinteger required

Maximum sessions per minute the PID controller can set. Prevents the rate from exceeding infrastructure capacity.

pidBatchMode'Total' | 'PerBatch' | 'PerBatchTimeWeighted' required

serveTimeoutSecondsinteger nullable required

Maximum time in seconds a user has to submit an answer after loading the task. Null uses the system-wide default.

drainDurationSecondsinteger required

Grace period in seconds after an item stops receiving new serves, allowing in-flight responses to complete.

serveToResponseRationumber double nullable required

Ratio of serves to responses used to calculate how many tasks to serve per expected response.

criteriastring nullable required

The comparison instruction shown to annotators during ranking tasks (e.g. "Which image is sharper?").

startingElointeger required

The initial Elo rating assigned to new items entering the ranking. Standard default is 1200.

minResponsesinteger required

Minimum number of responses a ranking item must receive before it is considered sufficiently evaluated.

maxResponsesinteger nullable required

Maximum number of responses a ranking item can receive before being removed from active ranking. Null allows unlimited responses.

serveResponsesinteger nullable required

Number of accepted responses per rapid at which to stop serving. Null defaults to MaxResponses.

ownerIdstring uuid required

The ID of the customer who owns the flow.

ownerMailstring required

The email of the customer who owns the flow.

organizationIdstring required

The id of the organization that owns the entity.

createdAtstring date-time required

The timestamp when the flow was created.