checks

Run Platform Check

Changed on

Run one check against an authorized resource snapshot.

post/v2/checks/{check_key}/runs

Request

  • Base URL
    https://api.hud.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.hud.ai/v2/checks/{check_key}/runs
  • Auth
    none declared

Path parameters

check_keystring required

Request body

subject_type'environment' | 'taskset' | 'task' | 'trace' required

Platform resources supported by the check framework.

subject_idstring uuid required
overwriteboolean

Response

Successful Response

idstring uuid required
check_keystring required
definition_versioninteger required
definition_snapshotobject required
definition_hashstring required
executor_type'deterministic' | 'scenario_agent' required

Execution mechanisms supported by a check definition.

subject_type'environment' | 'taskset' | 'task' | 'trace' required

Platform resources supported by the check framework.

subject_idstring uuid required
subject_snapshotobject required
snapshot_hashstring required
status'running' | 'passed' | 'failed' | 'error' required

Lifecycle states for a platform check run.

resultobject
summarystring nullable required
errorstring nullable required
execution_trace_idstring uuid nullable required
attemptinteger required
created_atstring date-time required
completed_atstring date-time nullable required

Changes

  • 76e7e99cfcd1Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 74fedf0c50baRevision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status