Playground

Run a playground query as the current workspace

post/playground/run

Request

  • Base URL: https://api.flashdata.dev/v2
  • URL: https://api.flashdata.dev/v2/playground/run
  • Auth: API key in cookie __Host-fd_session and API key in header X-CSRF-Token

Request body

sourcestring required
mode'realtime' | 'async' | 'batch' required
queryobject required

Source request body. In batch mode, also accepts an object containing only queries, an array of 1 to 20 request bodies. Every entry must match the selected source and its input schema. Search and Suggestions require query; Channel requires handle; Metadata, Transcript, Captions, Trainability and Download require an 11-character video_id matching [A-Za-z0-9_-]. Download batch entries must supply params.storage for customer storage; console browser delivery is not supported in this envelope. Account batch and pending-job limits still apply.

Response

Upstream Data API response captured for the playground

bodyunknown required
endpoint'/v1/queries' | '/v1/queries/batch' | '/v1/queries/realtime' required
mode'realtime' | 'async' | 'batch' required
statusinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.