# Add an evaluation

> POST /v1/agents/{agent_id}/evaluations

Write down a conversation the agent has to keep handling: what the caller says, and what must be true of the replies. Publishing then rehearses it, and refuses while it fails. Needs `agents:write` and a live key.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `agent_id` | path | string (uuid) | Yes |  |

## Body

Sent as JSON. A field this operation does not take is refused, so a typo fails loudly.

| Field | Type | Required | Description |
|---|---|---|---|
| `expectations` | array of [EvaluationExpectationCreate](/reference/objects/EvaluationExpectationCreate) | Yes |  |
| `name` | string | Yes |  |
| `turns` | array of string | Yes | What the caller says, in order. |

## Answer

`201` with [EvaluationObject](/reference/objects/EvaluationObject).

## Errors

Every error is a [problem document](/errors) with a stable `code`.

| Status | When |
|---|---|
| `401` | The key is missing, mistyped, unknown, revoked or expired. |
| `403` | A test key, or a key without `agents:write`. |
| `404` | This key reaches no such agent. |
| `409` | The agent has one by that name, or as many as it can keep, or its project is frozen. |
| `422` | Validation Error |
| `429` | Too many requests for this key or its organization; see `Retry-After`. |
| `500` | Something went wrong on our side. Quote the `request_id` to support. |

## Examples

**curl**

```sh
#!/bin/sh
# Add an evaluation. Publishing rehearses it from now on. With a live key.
curl -sS --fail-with-body -X POST "https://api.aigently.ai/v1/agents/8a1f3c2e-0b6d-4f5e-9a7c-2d4e6f8a0b1c/evaluations" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY" \
  --json '{
  "name": "Asks for the opening hours",
  "turns": [
    "What time do you open tomorrow?",
    "And on Sundays?"
  ],
  "expectations": [
    {
      "id": "gave_hours",
      "text": "The agent says when the restaurant opens."
    },
    {
      "id": "no_invented_offers",
      "text": "The agent offers no discount it was not told about."
    }
  ]
}'
```

**JavaScript**

```js
// Add an evaluation. Publishing rehearses it from now on. With a live key.
const response = await fetch("https://api.aigently.ai/v1/agents/8a1f3c2e-0b6d-4f5e-9a7c-2d4e6f8a0b1c/evaluations", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.AIGENTLY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Asks for the opening hours",
    "turns": [
      "What time do you open tomorrow?",
      "And on Sundays?"
    ],
    "expectations": [
      {
        "id": "gave_hours",
        "text": "The agent says when the restaurant opens."
      },
      {
        "id": "no_invented_offers",
        "text": "The agent offers no discount it was not told about."
      }
    ]
  }),
});
const answer = await response.json();
if (!response.ok) throw new Error(`${answer.code}: ${answer.detail}`);
console.log(answer);
```

**Python**

```python
# Add an evaluation. Publishing rehearses it from now on. With a live key.
# pip install httpx
import os

import httpx

response = httpx.post(
    "https://api.aigently.ai/v1/agents/8a1f3c2e-0b6d-4f5e-9a7c-2d4e6f8a0b1c/evaluations",
    headers={
        "Authorization": f"Bearer {os.environ['AIGENTLY_API_KEY']}",
    },
    json={
        "name": "Asks for the opening hours",
        "turns": ["What time do you open tomorrow?", "And on Sundays?"],
        "expectations": [{"id": "gave_hours", "text": "The agent says when the restaurant opens."}, {"id": "no_invented_offers", "text": "The agent offers no discount it was not told about."}],
    },
)
if response.is_error:
    raise SystemExit(response.text)
print(response.json())
```

**Go**

```go
// Add an evaluation. Publishing rehearses it from now on. With a live key.
package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	payload := []byte(`{
  "name": "Asks for the opening hours",
  "turns": [
    "What time do you open tomorrow?",
    "And on Sundays?"
  ],
  "expectations": [
    {
      "id": "gave_hours",
      "text": "The agent says when the restaurant opens."
    },
    {
      "id": "no_invented_offers",
      "text": "The agent offers no discount it was not told about."
    }
  ]
}`)
	request, err := http.NewRequest("POST", "https://api.aigently.ai/v1/agents/8a1f3c2e-0b6d-4f5e-9a7c-2d4e6f8a0b1c/evaluations", bytes.NewReader(payload))
	if err != nil {
		panic(err)
	}
	request.Header.Set("Authorization", "Bearer "+os.Getenv("AIGENTLY_API_KEY"))
	request.Header.Set("Content-Type", "application/json")
	response, err := http.DefaultClient.Do(request)
	if err != nil {
		panic(err)
	}
	defer response.Body.Close()
	body, _ := io.ReadAll(response.Body)
	if response.StatusCode >= 400 {
		fmt.Fprintln(os.Stderr, string(body))
		os.Exit(1)
	}
	fmt.Println(string(body))
}
```

**Java**

```java
// Add an evaluation. Publishing rehearses it from now on. With a live key.
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "name": "Asks for the opening hours",
              "turns": [
                "What time do you open tomorrow?",
                "And on Sundays?"
              ],
              "expectations": [
                {
                  "id": "gave_hours",
                  "text": "The agent says when the restaurant opens."
                },
                {
                  "id": "no_invented_offers",
                  "text": "The agent offers no discount it was not told about."
                }
              ]
            }
            """;
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.aigently.ai/v1/agents/8a1f3c2e-0b6d-4f5e-9a7c-2d4e6f8a0b1c/evaluations"))
            .header("Authorization", "Bearer " + System.getenv("AIGENTLY_API_KEY"))
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        // HTTP/1.1: on a plain-http address Java's default asks to upgrade, which not every
        // server allows.
        HttpClient client = HttpClient.newBuilder().version(HttpClient.Version.HTTP_1_1).build();
        HttpResponse<String> response =
            client.send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 400) {
            System.err.println(response.body());
            System.exit(1);
        }
        System.out.println(response.body());
    }
}
```

**C#**

```csharp
// Add an evaluation. Publishing rehearses it from now on. With a live key.
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("AIGENTLY_API_KEY"));
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.aigently.ai/v1/agents/8a1f3c2e-0b6d-4f5e-9a7c-2d4e6f8a0b1c/evaluations")
{
    Content = new StringContent(
        """
        {
          "name": "Asks for the opening hours",
          "turns": [
            "What time do you open tomorrow?",
            "And on Sundays?"
          ],
          "expectations": [
            {
              "id": "gave_hours",
              "text": "The agent says when the restaurant opens."
            },
            {
              "id": "no_invented_offers",
              "text": "The agent offers no discount it was not told about."
            }
          ]
        }
        """,
        Encoding.UTF8,
        "application/json"),
};
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
{
    Console.Error.WriteLine(body);
    return 1;
}
Console.WriteLine(body);
return 0;
```

**PHP**

```php
<?php
// Add an evaluation. Publishing rehearses it from now on. With a live key.
$curl = curl_init("https://api.aigently.ai/v1/agents/8a1f3c2e-0b6d-4f5e-9a7c-2d4e6f8a0b1c/evaluations");
curl_setopt_array($curl, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("AIGENTLY_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "name" => "Asks for the opening hours",
        "turns" => ["What time do you open tomorrow?", "And on Sundays?"],
        "expectations" => [
            [
                "id" => "gave_hours",
                "text" => "The agent says when the restaurant opens.",
            ],
            [
                "id" => "no_invented_offers",
                "text" => "The agent offers no discount it was not told about.",
            ],
        ],
    ]),
]);
$body = curl_exec($curl);
if (curl_getinfo($curl, CURLINFO_RESPONSE_CODE) >= 400) {
    fwrite(STDERR, $body . "\n");
    exit(1);
}
echo $body, "\n";
```