Skip to main content
POST
Confirm instructions

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth/tokens.

Path Parameters

device_id
string
required

Flatpeak Device ID.

Example:

"dev_63a6087272941ef077a8fd3e"

Body

application/json

What the device will deliver for each instruction segment you fetched.

data
InstructionConfirmationSegment · object[]
required

One entry per instruction segment, or per part of one, in chronological order. A segment you leave out is unconfirmed: the device is expected to follow it and is scored on delivery as usual.

record_reference_id
string

Optional unique identifier for the submission. Resubmitting the same value returns the stored confirmation.

Example:

"nova-7d1c-2026-08-04T16:01"

Response

Instruction confirmation response.

What the device will deliver for its instructions, as you confirmed it.

id
string
required

Flatpeak Instruction Confirmation ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"icf_6a284b7596d3f2b722544e70"

object
enum<string>
required

Object type, instruction_confirmation.

Available options:
instruction_confirmation
Example:

"instruction_confirmation"

live_mode
boolean
required

true for live data, false for test data.

device_id
string
required

Flatpeak Device ID.

Example:

"dev_63a6087272941ef077a8fd3e"

record_reference_id
string | null
required

The record_reference_id the confirmation was submitted with.

Example:

"nova-7d1c-2026-08-04T16:01"

data
InstructionConfirmationRow · object[]
required

Confirmed windows, in chronological order, each beside the instruction it answers.

response
ResponseTimeSample · object
required

How quickly the instructions were fetched and confirmed.

time_created
string<date-time>
required

Time when this object was created, in UTC.

Example:

"2026-08-04T16:01:40Z"

account_id
string
required

Flatpeak Account ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"acc_661677911f2197045e6cf1b1"