Get scored metrics and provenance

GET

api

evaluations

{id}

result

Get scored metrics and provenance

curl --request GET \
  --url https://dev.simforge.ai/api/v1/evaluations/{id}/result \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dev.simforge.ai/api/v1/evaluations/{id}/result', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "manifestSchema": "<string>",
  "status": "succeeded",
  "scored": true,
  "evidenceRetainedUntil": "<string>",
  "manifest": {},
  "metrics": {},
  "artifacts": [
    {
      "role": "<string>",
      "artifactId": "<string>",
      "mediaType": "<string>",
      "bytes": 1,
      "sha256": "<string>"
    }
  ]
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Path Parameters

string

required

Response

Evaluation data.

manifestSchema

string

required

status

enum<string>

required

Available options:

succeeded,

partial,

failed,

cancelled

scored

boolean

required

evidenceRetainedUntil

string | null

required

manifest

object

required

Show child attributes

metrics

object

required

Show child attributes

artifacts

object[]

required

Show child attributes

⌘I

Get scored metrics and provenance

curl --request GET \
  --url https://dev.simforge.ai/api/v1/evaluations/{id}/result \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dev.simforge.ai/api/v1/evaluations/{id}/result', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "manifestSchema": "<string>",
  "status": "succeeded",
  "scored": true,
  "evidenceRetainedUntil": "<string>",
  "manifest": {},
  "metrics": {},
  "artifacts": [
    {
      "role": "<string>",
      "artifactId": "<string>",
      "mediaType": "<string>",
      "bytes": 1,
      "sha256": "<string>"
    }
  ]
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

Cloud API

Endpoints

Get scored metrics and provenance

Authorizations

Path Parameters

Response