Schedule a demo

Robust simulation & evaluation for your AI agents

API Reference

Integrate Coval into your pipeline seamlessly through our API

In this quickstart you will learn how to:

  1. Create Account
  2. Create API Key
  3. Run first evaluation using a Transcript
1

Create Account

Set up a Coval account. If you don’t have one, sign up here

2

Create API Key

API credentials (You can find these in your Coval dashboard) On the navigation bar left, click on your organisation > Manage > Manage API Keys

Coval Api

3

Run First Evaluation

To start evaluating your AI agent’s performance, you can push a transcript to Coval using our monitoring API. Here’s how to do it:

For detailed information on the /eval/transcript endpoint and its usage, please refer to our Monitoring API documentation.

  1. Prepare your transcript data in JSON format.
[
  {
    "role": "user",
    "content": "Hello, how are you?"
  },
  {
    "role": "agent",
    "content": "I'm good, thanks!"
  }
]
  1. Include your API key in the request header for authentication.
  2. Send a POST request to the /eval/transcript endpoint.

Here is a basic example with python:


import requests

url = "https://api.coval.dev/eval/transcript"

payload = {
"transcript": [{"role":"user","content":"Hello, how are you?"},
               {"role": "agent","content": "I'm good, thanks!"}],
"metrics": {},
"metadata": {"agent_id": "<string>"},
"simulators": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

Here’s a basic example using curl:

curl -X POST 'https://api.coval.dev/eval/transcript' \
    -H 'Content-Type: application/json' \
    -H 'x-api-key: YOUR_API_KEY_HERE' \
    -d '{
      "transcript": [
        {"role": "user", "content": "Hello, how are you?"},
        {"role": "agent", "content": "I'\''m good, thanks!"}
      ],
      "simulators": {},
      "metrics": {},
      "metadata": {"agent_id": "YOUR_AGENT_ID_HERE"}
    }'

Was this page helpful?