SPsponsorunited
Vortex

Push a reviewed Vortex Desktop session as an audio report

Changed on

Files the brands and assets a Vortex Desktop session detected in its recordings as an audio report: the same report and rows POST /api/vortex/audit/bulk writes, except that the audits are recorded as by-audio audits (type 12), which is what the Pro Tool's Scout By Audio review screen lists and plays. Nothing is transcribed. Every item must name at least one recording by the id POST /api/vortex/upload-audio-from-url returned, with the clip it was heard in as fragments (seconds, fractional). Every company receives every item, so send one brand per request. With partial true, a missing brand or asset id is saved as the Unknown Brand or Unknown Asset, and description keeps what was heard. For the recording to be playable on the review screen it must also be attached to the report with POST /api/vortex/user-event-uploads, media_type audio. A report created here records user_id as Captured By; a report that already exists is found by its Captured By. Authenticated via X-API-Key.

post/api/vortex/audit/audio-bulk

Request

Request body

user_idinteger required

ID of the user who captured the scouting session. Recorded as the report's Captured By when the report is created here, and used as its first Assigned To.

isQuickAddboolean

Whether this is a quick-add session (always true for vortex)

partialboolean

Marks the payload as partial rows. With it, companies and items may be empty and their id may be null: a missing brand is saved as the Unknown Brand and a missing asset as the Unknown Asset, one row per image. Without it, a missing id is rejected.

idinteger required

Audio id

Example request

{
  "items": [
    {
      "audios": [
        {
          "fragments": [
            {
              "start": 12.5,
              "end": 17.25
            }
          ]
        }
      ],
      "detectionConfidence": 0.92
    }
  ],
  "fragments": [
    {
      "start": 12.5,
      "end": 17.25
    }
  ]
}

Response

Item values created

object[] required

Changes

  • cbf1ca5bff8fRevision changes
    • info

      added the new optional request property //////

    • info

      added the new optional request property ///