Skip to main content
GET
/
api
/
dataframer
/
transform-jobs
/
{job_id}
/
files
/
{sample_index}
/
content
Python
import os
from dataframer import Dataframer

client = Dataframer(
    api_key=os.environ.get("DATAFRAMER_API_KEY"),  # This is the default and can be omitted
)
response = client.dataframer.transform_jobs.files.file_content(
    sample_index=0,
    job_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response.content)
{
  "content": "<string>",
  "file_name": "<string>",
  "file_type": "<string>",
  "sample_index": 123,
  "entities_found": [
    {}
  ],
  "entity_summary": {}
}

Authorizations

Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Path Parameters

job_id
string<uuid>
required

UUID of the completed transform job.

sample_index
integer
required

Zero-based index of the sample to retrieve.

Required range: x >= 0

Response

Transformed file content

Content of a single transformed file/sample.

content
string

Masked/redacted file content.

file_name
string

Original file name.

file_type
string

File type extension in uppercase (e.g. JSON, TXT, CSV).

sample_index
integer

Zero-based index of this sample within the job results.

entities_found
object[]

List of PII/PHI entities detected in this sample.

entity_summary
object

Count of entities found per entity type (e.g. {"PERSON": 3, "EMAIL": 1}).