Evaluators

Deploy Evaluator Revision

Changed on

Pin an evaluator revision into an environment revision under a key.

Requires an evaluator ref (evaluator_ref, evaluator_variant_ref, or evaluator_revision_ref) and an environment ref. When key is omitted it defaults to <evaluator_slug>.revision. The deployment is recorded as a new commit on the environment revision. See the Evaluators guide for the deployment model.

post/evaluators/revisions/deploy

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/evaluators/revisions/deploy
  • Auth
    API key in header Authorization

Request body

keystring nullable

Named key under which the revision is pinned. Defaults to <evaluator_slug>.revision.

messagestring nullable

Commit message stored on the environment revision that records the deployment.

Response

Successful Response

countinteger

1 when a revision is returned, 0 otherwise.

Changes

  • 5a14788d939fRevision changes
    • info

      added to the response property anyOf list for the response status

    • info

      removed from the response property anyOf list for the response status

  • b2f21936417eRevision changes
    • info

      added the optional property to the response with the status