Skip to content
AveraAveraAvera Documentation

Record a batch of responses on an execution

POST
/api/v1/items/{executionId}/responses
curl --request POST \
  --url https://app.avera.io/api/v1/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/responses \
  --header 'Content-Type: application/json' \
  --data '{ "responses": [ { "promptId": "example", "subjectKey": "example", "outcome": "example", "valueNumber": 1, "valueUnit": "example", "valueText": "example", "valueChoice": "example", "valueRef": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "deviationRef": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "evidence": [ { "fileId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "uri": "example", "sha256": "example", "bytes": 1 } ], "retract": true } ] }'

Each entry is a typed response payload, validated and gated individually; the batch applies as one commit and is refused whole on the first refusal. Returns the execution’s record as it now stands.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
executionId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
responses
required
Array<object>
>= 1 items
object
promptId
required
string
>= 1 characters
subjectKey
string | null
outcome
string | null
valueNumber
number | null
valueUnit
string | null
valueText
string | null
valueChoice
string | null
valueRef
string | null format: uuid
deviationRef
string | null format: uuid
evidence
required
Array<object>
object
fileId
string | null format: uuid
uri
string | null
sha256
string | null
bytes
integer | null format: int64
retract
required
boolean

Example generated

{
  "responses": [
    {
      "promptId": "example",
      "subjectKey": "example",
      "outcome": "example",
      "valueNumber": 1,
      "valueUnit": "example",
      "valueText": "example",
      "valueChoice": "example",
      "valueRef": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "deviationRef": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "evidence": [
        {
          "fileId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "uri": "example",
          "sha256": "example",
          "bytes": 1
        }
      ],
      "retract": true
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
Array<object>
object
id
required
string format: uuid
executionCanonicalId
required
string format: uuid
promptId
required
string
subjectKey
required
string
seq
required
integer format: int64
rowSeq
required
integer format: int64
outcome
string | null
valueNumber
number | null
valueUnit
string | null
valueText
string | null
valueChoice
string | null
valueRef
string | null format: uuid
deviationRef
string | null format: uuid
evidence
required
Array<object>
object
fileId
string | null format: uuid
uri
string | null
sha256
string | null
bytes
integer | null format: int64
recordedAt
required
string format: date-time
recordedBy
required
string format: uuid
changeAuthor
required
string
Allowed values: USER AI SYSTEM