Submissions

Route Guide

Getting Submission Progress

Get Submission by id

GET domain.api/api/v1/submissions/:id

Provides JSON Object describing the state of a submission.

Path Parameters

Name	Type	Description
:id*	String	ID of the submission

Headers

Name	Type	Description
Content-Type	application/json

200: OK Pending Submission Object

{
  "code": 200,
  "data": {
    "_id": "...",
    "is_pending": boolean,
    "success": boolean,
    "stage": "..."
    "recipeId": "..."
  }
}

500: Internal Server Error Internal Error

404: Not Found Submission Not Found

This endpoint is intended to be used for short polling to fetch the status of a submission until a conclusion (success/failure) of its processing. The recommended interval between requests is 4500 miliseconds.

This is a temporary implementation and will eventually be replaced by either:

(i) a WebSocket connection to a horizontally scalable Event Dispatch Worker implemented using Cloudflare Workers & Durable Objects. or

(ii) An implementation of Server Sent Events on an Event Dispatch Worker built using Cloudflare Workers.