Skip to main content
GET
/
api
/
dataframer
/
human-labels
/
{label_id}
JavaScript
import Dataframer from 'dataframer';

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

const humanLabel = await client.dataframer.humanLabels.retrieve('label_id');

console.log(humanLabel.file_identifier);
{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "file_identifier": "<string>",
  "labels": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sample_identifier": "<string>",
  "created_by": 123,
  "created_by_name": "<string>",
  "updated_by": 123,
  "updated_by_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Path Parameters

label_id
string
required

Response

200 - application/json
run_id
string<uuid>
required
file_identifier
string
required

Identifier for the file (filename or folder/filename path)

labels
Labels · object
required

JSON object mapping label keys to values

id
string<uuid>
company_id
string<uuid>
sample_identifier
string | null

Optional: row identifier for structured files (e.g., "sample_0")

created_by
integer | null
created_by_name
string
updated_by
integer | null
updated_by_name
string
created_at
string<date-time>
updated_at
string<date-time>