Limai Docs
API ReferenceBenchmarks

Files

List benchmark files and get file-level metrics

List Execution Files

GET/api/v1/benchmarks/{executionId}/files

Returns all files included in a benchmark execution with their success rates.

Parameters

NameTypeInRequiredDescription
executionIdstringpathYesThe benchmark execution ID

Request

const res = await fetch(
"https://app.limai.io/api/v1/benchmarks/exec_abc123/files",
{
  headers: {
    Authorization: "Bearer YOUR_API_TOKEN",
  },
}
);
const { data } = await res.json();

Response

Response200
{
  "data": [
    {
      "fileId": "file_001",
      "fileName": "invoice_001.pdf",
      "successRate": 0.95,
      "totalRows": 3,
      "status": "COMPLETED"
    },
    {
      "fileId": "file_002",
      "fileName": "invoice_002.pdf",
      "successRate": 0.88,
      "totalRows": 5,
      "status": "COMPLETED"
    }
  ]
}

Get File Metrics

GET/api/v1/benchmarks/{executionId}/files/{fileId}

Returns detailed metrics for a specific file in a benchmark execution.

Parameters

NameTypeInRequiredDescription
executionIdstringpathYesThe benchmark execution ID
fileIdstringpathYesThe file ID

Request

const res = await fetch(
"https://app.limai.io/api/v1/benchmarks/exec_abc123/files/file_001",
{
  headers: {
    Authorization: "Bearer YOUR_API_TOKEN",
  },
}
);
const fileMetrics = await res.json();

Response

Response200
{
  "fileId": "file_001",
  "fileName": "invoice_001.pdf",
  "successRate": 0.95,
  "totalRows": 3,
  "status": "COMPLETED"
}