Dynamiq
Evaluations

Get an evaluation

Returns a single evaluation run, including its status and configuration.

GET
/v1/evaluations/{evaluation_id}

Authorization

personalAccessToken
AuthorizationBearer <token>

Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.

In: header

Path Parameters

evaluation_id*string

Evaluation UUID.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/evaluations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "status": "pending",
    "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
    "dataset_version_id": "04e89766-1052-429f-ac43-0b0a79802db7",
    "config": [
      {
        "workflow": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
          "input_transformer": {
            "path": "string",
            "selector": {
              "property1": "string",
              "property2": "string"
            }
          }
        },
        "metrics": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
            "input_transformer": {
              "path": "string",
              "selector": {
                "property1": "string",
                "property2": "string"
              }
            }
          }
        ]
      }
    ],
    "started_at": "2019-08-24T14:15:22Z",
    "started_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    },
    "ended_at": "2019-08-24T14:15:22Z",
    "ended_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Start an evaluation

Starts a batch evaluation run. Each workflow in `config` is executed against every item of the released dataset version, then the configured metrics score the outputs. The dataset version must be released. Execution is asynchronous: the run is persisted and fanned out onto a task queue, and the response is returned immediately with `status` `running`. Poll the run — or its results — for completion. Status is one of `pending`, `running`, `failed`, `succeeded`, or `canceled`.

Delete an evaluation

Deletes an evaluation run along with its workflow runs, metric scores, and results.