---
id: evaluator-run-evaluators-evaluator-key-run-post
title: "Evaluator Run"
description: "Endpoint to evaluate LLM app run"
sidebar_label: "Evaluator Run"
hide_title: true
hide_table_of_contents: true
api: eJztVk1v2zgQ/SsETymQ2tlgTzrVzQao0RQJHO9eUsNgpLHNVia5JJXWFfzfd4akvuzaRXPeBEgo8c3wzdejau7F2vHsid++iLISXlvHF5e8AJdbabzUimf8VhVGS+WZ1wwiDtjd3ScmjGG2Up/xd2LXLvusGP5Y+LcC59nFLC7eZGy+gfa1fv4CuR9FLDTHLr/Cjl04bxOaHvWKeVy2mGRjxK7UomAXLeepMpWfKg92JXJIHhpYrpUXUkm1Dt4aGoXwYkTMZ+Arqzryrip9xlrf95XvO0/0D73qgHIjfsm1ASsoc9MCc9cFiIlatk9uuRyEvgzbRjuPHoywYgt4IFWm5gofBp4QjyhJpTHCb3BNQUkLeKC3FVxyl29gK3hWc78zZIyJRaqI9NKX9KKNj31Eb/v9IjrBzLzXxY4sD31SxKA8bWHdS5mHIMdfHPVI3TvSWEqBl+DoSVJtXI9KTGCPyjQi9kgbvEeaAS3U7n4V4h/a7S/bN6oqS07MG0+PjT36ypE60pWifLW7m56LPbo8FcCJPkQbssKOMlq5mI3rqyv6N5yvxyrPwblVVbJZAvNX5zt14rmE3yfIz2Lqqv7Uulr8JNSDsUix/nl9fRzeP6KURSDPbq3V9vWxFYAzV4au8rB1x4BS54Pdo6qnOehVHXUN1mCx8F02hLVi10vYnY4Eqa+2bn1urj5hIcUaeOvszAhSMticdn9VCYorHp1wvZJ06Y3ZPR3GXzF951r5w3z+cOQw1hYVaaNJ0lqVQunJ+LjTtHE90Kj9GDWN01Tbl0bLKovl4xvvjcvG47zUVTHCdKGWjoQcCyP54eUzCbvshqBhOh3klZV+F/xNHqaoXx9AFFjC7GnRBzxSF8W+GMLakuB5H4OWJomdVBiilT9isZPEbqIVpYD6c9ap5O13sTUlDFRuqGJHOkRepFrpQCLlPEX4XuRfQRV4LGUrBn81+mN0dSolyYBhcGmkRB5GqokmwHBrmPQ23biDU0bzxD2I7btug1hSlbdC9fx1V8Ys1HVAqu5m+v/vhd/6Xki96OG7H5sSMTTBoWR1mrGn7u53aJAdfgnQmGHfb2guEVzXz8LB37bc7+k10rc0LLh8EVaKZ2o6HJ1COlrjRK+wN+FMPUNhSIresFN8m4FSxIfo0RMuieDhp0tQ2k0zsnXC3MTj3gY97HwcXQ8k3dFigrem8Wexi55sPdw/zhH8nD5vtrogGyu+UQbxb+CrQ/hBM8I7vFKEWlek6BmPPunnP7Bh6Xo=
sidebar_class_name: "post api-method"
info_path: reference/api/agenta-backend
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading as={"h1"} className={"openapi__heading"} children={"Evaluator Run"}></Heading>

<MethodEndpoint method={"post"} path={"/evaluators/{evaluator_key}/run"}></MethodEndpoint>

Endpoint to evaluate LLM app run

Args:
request (Request): The request object.
evaluator_key (str): The key of the evaluator.
payload (EvaluatorInputInterface): The payload containing the request data.

Returns:
result: EvaluatorOutputInterface object containing the outputs.

<Heading id={"request"} as={"h2"} className={"openapi-tabs__heading"} children={"Request"}></Heading>

<details style={{ marginBottom: "1rem" }} className={"openapi-markdown__details"} data-collapsed={false} open={true}>
  <summary style={{}}>
    <h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3>
  </summary>
  <div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{
          name: "evaluator_key",
          in: "path",
          required: true,
          schema: { type: "string", title: "Evaluator Key" },
        }}
      ></ParamsItem>
    </ul>
  </div>
</details>
<MimeTabs className={"openapi-tabs__mime"}>
  <TabItem label={"application/json"} value={"application/json-schema"}>
    <details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}>
      <summary style={{}} className={"openapi-markdown__details-summary-mime"}>
        <h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3>
        <strong className={"openapi-schema__required"}>required</strong>
      </summary>
      <div style={{ textAlign: "left", marginLeft: "1rem" }}></div>
      <ul style={{ marginLeft: "1rem" }}>
        <SchemaItem
          collapsible={false}
          name={"inputs"}
          required={false}
          schemaName={"object"}
          qualifierMessage={undefined}
          schema={{ type: "object", title: "Inputs" }}
        ></SchemaItem>
        <SchemaItem collapsible={true} className={"schemaItem"}>
          <details style={{}} className={"openapi-markdown__details"}>
            <summary style={{}}>
              <strong>settings</strong>
              <span style={{ opacity: "0.6" }}>object</span>
            </summary>
            <div style={{ marginLeft: "1rem" }}></div>
            <div>
              <span className={"badge badge--info"}>anyOf</span>
            </div>
          </details>
        </SchemaItem>
        <SchemaItem collapsible={true} className={"schemaItem"}>
          <details style={{}} className={"openapi-markdown__details"}>
            <summary style={{}}>
              <strong>credentials</strong>
              <span style={{ opacity: "0.6" }}>object</span>
            </summary>
            <div style={{ marginLeft: "1rem" }}></div>
            <div>
              <span className={"badge badge--info"}>anyOf</span>
            </div>
          </details>
        </SchemaItem>
      </ul>
    </details>
  </TabItem>
</MimeTabs>
<div>
  <div>
    <ApiTabs label={undefined} id={undefined}>
      <TabItem label={"200"} value={"200"}>
        <div>Successful Response</div>
        <div>
          <MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}>
            <TabItem label={"application/json"} value={"application/json"}>
              <SchemaTabs className={"openapi-tabs__schema"}>
                <TabItem label={"Schema"} value={"Schema"}>
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary style={{}} className={"openapi-markdown__details-summary-response"}>
                      <strong>Schema</strong>
                    </summary>
                    <div style={{ textAlign: "left", marginLeft: "1rem" }}></div>
                    <ul style={{ marginLeft: "1rem" }}>
                      <SchemaItem
                        collapsible={false}
                        name={"outputs"}
                        required={true}
                        schemaName={"object"}
                        qualifierMessage={undefined}
                        schema={{ type: "object", title: "Outputs" }}
                      ></SchemaItem>
                    </ul>
                  </details>
                </TabItem>
                <TabItem label={"Example (from schema)"} value={"Example (from schema)"}>
                  <ResponseSamples responseExample={'{\n  "outputs": {}\n}'} language={"json"}></ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
      <TabItem label={"422"} value={"422"}>
        <div>Validation Error</div>
        <div>
          <MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}>
            <TabItem label={"application/json"} value={"application/json"}>
              <SchemaTabs className={"openapi-tabs__schema"}>
                <TabItem label={"Schema"} value={"Schema"}>
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary style={{}} className={"openapi-markdown__details-summary-response"}>
                      <strong>Schema</strong>
                    </summary>
                    <div style={{ textAlign: "left", marginLeft: "1rem" }}></div>
                    <ul style={{ marginLeft: "1rem" }}>
                      <SchemaItem collapsible={true} className={"schemaItem"}>
                        <details style={{}} className={"openapi-markdown__details"}>
                          <summary style={{}}>
                            <span className={"openapi-schema__container"}>
                              <strong className={"openapi-schema__property"}>detail</strong>
                              <span className={"openapi-schema__name"}>object[]</span>
                            </span>
                          </summary>
                          <div style={{ marginLeft: "1rem" }}>
                            <li>
                              <div
                                style={{
                                  fontSize: "var(--ifm-code-font-size)",
                                  opacity: "0.6",
                                  marginLeft: "-.5rem",
                                  paddingBottom: ".5rem",
                                }}
                              >
                                Array [
                              </div>
                            </li>
                            <SchemaItem collapsible={true} className={"schemaItem"}>
                              <details style={{}} className={"openapi-markdown__details"}>
                                <summary style={{}}>
                                  <span className={"openapi-schema__container"}>
                                    <strong className={"openapi-schema__property"}>loc</strong>
                                    <span className={"openapi-schema__name"}>object[]</span>
                                    <span className={"openapi-schema__divider"}></span>
                                    <span className={"openapi-schema__required"}>required</span>
                                  </span>
                                </summary>
                                <div style={{ marginLeft: "1rem" }}>
                                  <li>
                                    <div
                                      style={{
                                        fontSize: "var(--ifm-code-font-size)",
                                        opacity: "0.6",
                                        marginLeft: "-.5rem",
                                        paddingBottom: ".5rem",
                                      }}
                                    >
                                      Array [
                                    </div>
                                  </li>
                                  <div>
                                    <span className={"badge badge--info"}>anyOf</span>
                                    <SchemaTabs>
                                      <TabItem label={"MOD1"} value={"0-item-properties"}>
                                        <div style={{ marginTop: ".5rem", marginBottom: ".5rem" }}>string</div>
                                      </TabItem>
                                      <TabItem label={"MOD2"} value={"1-item-properties"}>
                                        <div style={{ marginTop: ".5rem", marginBottom: ".5rem" }}>integer</div>
                                      </TabItem>
                                    </SchemaTabs>
                                  </div>
                                  <li>
                                    <div
                                      style={{
                                        fontSize: "var(--ifm-code-font-size)",
                                        opacity: "0.6",
                                        marginLeft: "-.5rem",
                                      }}
                                    >
                                      ]
                                    </div>
                                  </li>
                                </div>
                              </details>
                            </SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={"msg"}
                              required={true}
                              schemaName={"Message (string)"}
                              qualifierMessage={undefined}
                              schema={{ type: "string", title: "Message" }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={"type"}
                              required={true}
                              schemaName={"Error Type (string)"}
                              qualifierMessage={undefined}
                              schema={{ type: "string", title: "Error Type" }}
                            ></SchemaItem>
                            <li>
                              <div
                                style={{ fontSize: "var(--ifm-code-font-size)", opacity: "0.6", marginLeft: "-.5rem" }}
                              >
                                ]
                              </div>
                            </li>
                          </div>
                        </details>
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem>
                <TabItem label={"Example (from schema)"} value={"Example (from schema)"}>
                  <ResponseSamples
                    responseExample={
                      '{\n  "detail": [\n    {\n      "loc": [\n        "string",\n        0\n      ],\n      "msg": "string",\n      "type": "string"\n    }\n  ]\n}'
                    }
                    language={"json"}
                  ></ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>
