Skip to main content
POST
Draw documents to label

Authorizations

Authorization
string
header
required

An organization API key. Keys carry a role (read_write or read_only) and may be restricted to a namespace prefix such as acme/*, or to one namespace such as acme/prod/tenant_1. A prefix matches on a / boundary: acme/prod/tenant_1* covers acme/prod/tenant_1 and everything under acme/prod/tenant_1/, never acme/prod/tenant_12.

Path Parameters

ns
string
required

The namespace name, with any / sent as %2F. Up to 256 bytes. / separates levels of the hierarchy, as in acme/prod/tenant_123.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9._:/-]+$
name
string
required

A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Body

application/json
count
integer
default:50

How many documents to hand out at most.

Required range: 1 <= x <= 200
seed
integer<int64>
default:0

Fixes each band's random order. The same state and seed give the same items.

Required range: x >= 0

Response

The items drawn and leased; none when nothing is available.

Documents drawn from the labelling queue and leased (§6.10).

judgment
string
required

A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
version
integer<int32>
required
Required range: x >= 1
engine
string | null
required
engine_version
string | null
required

The epoch drawn from. Null while the version has no answers.

seed
integer<int64>
required
Required range: x >= 0
lease_expires_at
string<date-time> | null
required

When the items go back into the queue if not labelled. Null when nothing was drawn.

items
object[]
required

Lowest band first; within a band, in the seed's order.

Maximum array length: 200