Skip to content
POST/api/v1/voice/sessions

Persist a voice session and its turns

Stores a completed voice session (transport, timing, barge-ins, latency percentiles, agent talk ratio) and, optionally, its per-turn transcript plus per-turn scores. Requires the 'editor' role; `orgId` in the body is the tenant the row is written into and membership is verified before the handler runs. Body limit 8 MB; at most 5000 turns per call.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Request body required

Example

{
  "orgId": "00000000-0000-0000-0000-000000000000",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "externalSessionId": "string",
  "transport": "string",
  "metrics": {
    "turnCount": 0,
    "userTurns": 0,
    "agentTurns": 0,
    "bargeIns": 0,
    "responseLatenciesMs": [
      0
    ],
    "p50ResponseMs": 0,
    "p95ResponseMs": 0,
    "durationMs": 0,
    "agentTalkRatio": 0
  },
  "startedAt": "2026-01-01T00:00:00.000Z",
  "endedAt": "2026-01-01T00:00:00.000Z",
  "metadata": {},
  "turns": [
    {
      "id": "string",
      "speaker": "string",
      "startMs": 0,
      "endMs": 0,
      "transcript": "string",
      "finalized": false
    }
  ],
  "scoresByTurn": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "orgId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "projectId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "externalSessionId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 256
        },
        "transport": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "metrics": {
          "type": "object",
          "properties": {
            "turnCount": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "userTurns": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "agentTurns": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "bargeIns": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "responseLatenciesMs": {
              "maxItems": 10000,
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            "p50ResponseMs": {
              "nullable": true,
              "type": "number"
            },
            "p95ResponseMs": {
              "nullable": true,
              "type": "number"
            },
            "durationMs": {
              "type": "number",
              "minimum": 0
            },
            "agentTalkRatio": {
              "type": "number",
              "minimum": 0,
              "maximum": 1
            }
          },
          "required": [
            "turnCount",
            "userTurns",
            "agentTurns",
            "bargeIns",
            "durationMs",
            "agentTalkRatio"
          ],
          "additionalProperties": false
        },
        "startedAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
        },
        "endedAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {}
        },
        "turns": {
          "maxItems": 5000,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              },
              "speaker": {
                "type": "string",
                "minLength": 1,
                "maxLength": 32
              },
              "startMs": {
                "type": "number"
              },
              "endMs": {
                "nullable": true,
                "type": "number"
              },
              "transcript": {
                "type": "string",
                "maxLength": 100000
              },
              "finalized": {
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "speaker",
              "startMs",
              "transcript",
              "finalized"
            ],
            "additionalProperties": false
          }
        },
        "scoresByTurn": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "additionalProperties": {
              "type": "number"
            }
          }
        }
      },
      "required": [
        "orgId",
        "externalSessionId",
        "transport",
        "metrics"
      ],
      "additionalProperties": false
    }
  }
}

Response

All status codes

200Persisted. Returns `{ id, externalSessionId, turnsWritten }`.
400(no description)
401(no description)
403Caller is not an editor of `orgId`, or is not a member of it at all.
409Conflict — CONFLICT.
413`PAYLOAD_TOO_LARGE` — body exceeds the 8 MB limit.
429(no description)
500The session row, or the turn rows after it, failed to persist. A turn-write failure is reported separately: the session IS stored.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/voice/sessions \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "projectId": "00000000-0000-0000-0000-000000000000", "externalSessionId": "string", "transport": "string", "metrics": { "turnCount": 0, "userTurns": 0, "agentTurns": 0, "bargeIns": 0, "responseLatenciesMs": [ 0 ], "p50ResponseMs": 0, "p95ResponseMs": 0, "durationMs": 0, "agentTalkRatio": 0 }, "startedAt": "2026-01-01T00:00:00.000Z", "endedAt": "2026-01-01T00:00:00.000Z", "metadata": {}, "turns": [ { "id": "string", "speaker": "string", "startMs": 0, "endMs": 0, "transcript": "string", "finalized": false } ], "scoresByTurn": {} }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/voice/sessions", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "externalSessionId": "string",
    "transport": "string",
    "metrics": {
      "turnCount": 0,
      "userTurns": 0,
      "agentTurns": 0,
      "bargeIns": 0,
      "responseLatenciesMs": [
        0
      ],
      "p50ResponseMs": 0,
      "p95ResponseMs": 0,
      "durationMs": 0,
      "agentTalkRatio": 0
    },
    "startedAt": "2026-01-01T00:00:00.000Z",
    "endedAt": "2026-01-01T00:00:00.000Z",
    "metadata": {},
    "turns": [
      {
        "id": "string",
        "speaker": "string",
        "startMs": 0,
        "endMs": 0,
        "transcript": "string",
        "finalized": false
      }
    ],
    "scoresByTurn": {}
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/voice/sessions",
    headers=headers,
    json={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "externalSessionId": "string",
    "transport": "string",
    "metrics": {
        "turnCount": 0,
        "userTurns": 0,
        "agentTurns": 0,
        "bargeIns": 0,
        "responseLatenciesMs": [
            0
        ],
        "p50ResponseMs": 0,
        "p95ResponseMs": 0,
        "durationMs": 0,
        "agentTalkRatio": 0
    },
    "startedAt": "2026-01-01T00:00:00.000Z",
    "endedAt": "2026-01-01T00:00:00.000Z",
    "metadata": {},
    "turns": [
        {
            "id": "string",
            "speaker": "string",
            "startMs": 0,
            "endMs": 0,
            "transcript": "string",
            "finalized": False
        }
    ],
    "scoresByTurn": {}
},
)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"orgId":"00000000-0000-0000-0000-000000000000","projectId":"00000000-0000-0000-0000-000000000000","externalSessionId":"string","transport":"string","metrics":{"turnCount":0,"userTurns":0,"agentTurns":0,"bargeIns":0,"responseLatenciesMs":[0],"p50ResponseMs":0,"p95ResponseMs":0,"durationMs":0,"agentTalkRatio":0},"startedAt":"2026-01-01T00:00:00.000Z","endedAt":"2026-01-01T00:00:00.000Z","metadata":{},"turns":[{"id":"string","speaker":"string","startMs":0,"endMs":0,"transcript":"string","finalized":false}],"scoresByTurn":{}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/voice/sessions", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403409413429500

Other Monitoring endpoints