List StructFlow job history
Returns a list of jobs for the authenticated user, ordered by creation date descending.
Results do not include extracted output data.
Use GET /structflow/jobs/{job_id} to retrieve full results for a specific job.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List StructFlow job history › Responses
A list of jobs
Create a StructFlow job
Enqueues an asynchronous structured data extraction job.
Returns 202 Accepted immediately with a job_id.
Poll GET /structflow/jobs/{job_id} to retrieve results when the job is complete.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Create a StructFlow job › Request Body
modelModel ID obtained from GET /structflow/models
system_promptInstruction describing what structured data to extract and how
example_outputA JSON object showing the desired output structure with example values
List of input records to process. Mutually exclusive with 'file_id'.
file_idFile ID of a pre-uploaded JSONL file (one JSON record per line), obtained from POST /files. Mutually exclusive with 'inputs'. When used, results are returned as an 'output_file_id' instead of inline 'results'.
Create a StructFlow job › Responses
Job accepted
job_idUnique job identifier. Use this to poll for results.
modelstatusprogresscreated_atupdated_atexpires_atGet StructFlow job status and results
Returns the current status and full results of a job.
Poll this endpoint until status is completed or failed.
Recommended polling interval: 1-5 seconds.
Results are retained for a limited period after completion (expires_at).
Note: A job with status: completed may still contain individual records
with status: failed. Always check summary.failed_count and each
results[].status to detect partial failures.
path Parameters
job_idThe unique identifier of the job
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get StructFlow job status and results › Responses
Job details
job_idmodelstatusprogressResult summary. Present only when status is completed AND the job was submitted with 'inputs' (inline).
Extracted data per input record. Present only when status is completed AND the job was submitted with 'inputs' (inline). Each record may independently succeed or fail. For jobs submitted with 'file_id', use 'output_file_id' to download the results as a JSONL file.
Job-level error. Present only when job status is failed.
created_atupdated_atcompleted_atexpires_atoutput_file_idFile ID of the output JSONL file. Present only when status is completed AND the job was submitted with 'file_id' input. Each line contains either the extracted JSON for a successful record, or an object with a reserved '$error' key (e.g. {"$error":{"code":"...","message":"..."}}) for a failed record. Download via GET /files/{output_file_id}/content.