ingest
Preview
Process data using ingestion logic without saving it to a dataset.
POST
Authorizations
Use a Bearer token for authentication. Submit the token using the Authorization
header: Authorization: Bearer <token>.
Body
application/json
A description of the dataset to help the AI system understand the context.
Maximum string length:
10000Example:
"Employee dataset containing demographics and compensation."
A schema definition mapping field names to descriptions, to guide the AI system in structuring the extracted data.
Example:
{
"id": "unique employee identifier",
"name": "full employee name",
"age": "employee age in years",
"department": "work department",
"salary": "annual salary in USD"
}Additional instructions to guide the AI system during ingestion.
Response
Returns the processed preview data.
Example:
[
{
"id": "001",
"__metadata_textToTable": "name -> John Smith, age -> 28, department -> Engineering",
"name": "John Smith",
"age": "28",
"gender": "Male",
"department": "Engineering",
"location": "New York"
},
{
"id": "002",
"__metadata_textToTable": "name -> Sarah Johnson, age -> 32, department -> Marketing",
"name": "Sarah Johnson",
"age": "32",
"gender": "Female",
"department": "Marketing",
"location": "California"
},
{
"id": "003",
"name": "Michael Brown",
"age": "45",
"gender": "Male",
"department": "Finance",
"location": "Texas",
"__metadata_normalize": "Normalized department field from 'Fin Dept' to 'Finance'"
}
]