Retrieve Simulation Results

Retrieve Simulation Result

Changed on

Retrieve a single simulation result and its associated custom metrics.

Args: test_result_id: the ID of the simulation result to retrieve.

Returns: the simulation result along with its custom metric results.

get/v1/retrieve-simulation-result/{test_result_id}

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/retrieve-simulation-result/{test_result_id}
  • Auth
    HTTPBearer (a scheme the document does not define)

Path parameters

test_result_idinteger required

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

credits_usednumber nullable

Credits burned by this simulation result. Null until usage has landed and can be priced.

statusstring

Status of the response

Changes

  • 54d5bd5ab0bcRevision changes
    • info

      added the optional property //// to the response with the status

  • 409636928e98Revision changes
    • breaking

      for the path request parameter test_result_id, the type changed from string to integer