Skip to main content
GET
/
api
/
dataframer
/
runs
/
{run_id}
/
samples
JavaScript
import Dataframer from 'dataframer';

const client = new Dataframer({
  apiKey: 'My API Key',
});

const samples = await client.dataframer.runs.samples.list('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(samples);
{
  "task_id": "abc123",
  "status": "COMPLETED",
  "result": {
    "generated_outputs": [
      {
        "generated_sample": {
          "rating": "5 stars",
          "review": "Excellent!"
        },
        "metadata": {
          "finish_time": 1.23
        }
      }
    ]
  },
  "total_samples": 10,
  "returned_count": 10,
  "sample_statuses": [
    {
      "index": 0,
      "status": "completed"
    },
    {
      "index": 1,
      "status": "completed"
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Path Parameters

run_id
string
required

Query Parameters

offset
integer
default:0

Starting position in finish-time-ordered list (default: 0)

limit
integer

Maximum samples to return (default: all, max: 1000)

Response

Retrieved samples

The response is of type object.