Skip to main content

Retrieve execution results

GET 
/api/results/:uuid

This endpoint allows you to retrieve the results of a previously executed workflow.

Results are stored temporarily and are automatically deleted after having been fetched once. They are not guarenteed to be available after a certain period of time. Therefore, it is recommended to fetch the results as soon as possible, and to implement your own storage mechanism if you need to keep the results for a longer period of time.

As results may not be available just after the execution start, we recommend setting up a polling mechanism to check for the results:

You should adapt the polling strategy to your needs (w.r.t the expected duration of the workflow execution for example).

Request​

Path Parameters

uuid Uuidrequired

Responses​

If the run execution was successful, the response will be a JSON array containing the results.

The response contains an array of objects, each object representing one output. Each type of output has its own schema.

Example response from an object detection workflow:

[
  {
    "OBJECT_DETECTION": {
      "detections": [
        {
          "box": {
            "height": 804,
            "width": 291,
            "x": 9,
            "y": 250
          },
          "color": {
            "a": 54,
            "b": 253,
            "g": 11,
            "r": 70
          },
          "confidence": 0.9631829261779785,
          "id": 0,
          "label": "person"
        },
      ],
      "referenceImageIndex": 0
    }
  }
]
Loading...