Skip to main content
POST
TypeScript

Autorisations

Authorization
string
header
requis

A user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

bounty:submission:create

En-têtes

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Exemple:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

The claimed attempt to submit for review (btys_ tag).

Corps

application/json
deliverable
object | null

Work to attach to a livestream attempt. Combine urls, file_ids, and caption freely; all are optional. If the attempt already went to review when its stream ended, the deliverable attaches to it once, until reviewers start voting. Data capture attempts take no deliverable.

Réponse

attempt submitted for review

bounty_id
string
requis

The bounty the work was submitted to, prefixed bnty_.

Exemple:

"bnty_xxxxxxxxxxxxxx"

capture_clips
object[] | null
requis
Exemple:

null

capture_filename
string | null
requis

The vendor filename stem Country_City_Site_Station_Operator, derived from the capture metadata. null until every component is present.

Exemple:

"US_Austin_BurnetRd_Bay2_mwebb"

captured_clip_count
integer
requis

Number of verified capture clips accepted for this submission so far. 0 for submissions whose deliverable doesn't accumulate clips.

Exemple:

0

captured_duration_seconds
integer
requis

Total verified duration of accepted capture clips, in whole seconds. 0 for submissions whose deliverable doesn't accumulate clips.

Exemple:

0

city
string | null
requis

Capture metadata: city the footage was recorded in. null unless capture metadata was provided.

Exemple:

"Austin"

claimed_at
string | null
requis

When the worker claimed the submission, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

content
string | null
requis

Written proof the worker submitted with their work.

Exemple:

"Ceramic coating reveal, shot at the Burnet Rd bay"

country
string | null
requis

Capture metadata: country the footage was recorded in. null unless capture metadata was provided.

Exemple:

"US"

created_at
string
requis

When the submission was created, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

deliverable_type
enum<string> | null
requis

How the work arrived when it came in through the API in one shot, informational only — read the work from deliverable_urls, files, and capture_clips directly. null for submissions whose proof is a livestream recording, including ones that attached links or files on submit.

Options disponibles:
content_url,
media,
data_capture,
null
Exemple:

"media"

deliverable_urls
string[] | null
requis

Links submitted as work, followed by temporary download URLs for the uploaded files. null when the submission carries neither.

denial_reason
string | null
requis

Why the submission was denied, when a presentable reason exists. Always null unless status is denied.

Exemple:

"The clip never shows the finished paint."

device
string | null
requis

Capture metadata: device the footage was recorded on. null unless capture metadata was provided.

Exemple:

"iPhone 15 Pro"

files
object[]
requis
fov
integer | null
requis

Capture metadata: horizontal field of view in degrees. null when not reported.

Exemple:

120

id
string
requis

Submission ID, prefixed btys_.

Exemple:

"btys_xxxxxxxxxxxxxx"

latest_proof_livestream_feed
object | null
requis

Latest public proof livestream attached to the submission.

operator
string | null
requis

Capture metadata: identifier of the person who recorded the footage. null unless capture metadata was provided.

Exemple:

"mwebb"

resolved_at
string | null
requis

When the submission was approved or denied, as an ISO 8601 timestamp. null until then.

Exemple:

"2026-01-01T12:00:00.000Z"

site
string | null
requis

Capture metadata: site or venue the footage was recorded at. null unless capture metadata was provided.

Exemple:

"BurnetRd"

station
string | null
requis

Capture metadata: station or position within the site. null unless capture metadata was provided.

Exemple:

"Bay2"

status
enum<string> | null
requis

Lifecycle state. in_progress submissions are active attempts that have not submitted proof yet; submitted submissions await review; approved submissions were accepted and paid; denied submissions were rejected. null when the attempt ended without proof, taking it out of the public lifecycle — those attempts are absent from every public list and read.

Options disponibles:
in_progress,
submitted,
approved,
denied,
null
Exemple:

"submitted"

submitted_at
string | null
requis

When proof was submitted for review, as an ISO 8601 timestamp. null while the attempt is in progress.

Exemple:

"2026-01-01T12:00:00.000Z"

updated_at
string
requis

When the submission was last updated, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

worker
object
requis

User who submitted the work.