DimerIQ request and response reference
Exact routes, key fields and a downloadable OpenAPI contract.
Operations
| Operation | Request | Result |
|---|---|---|
| List Jobs | GET /api/science/jobs | See schema and notes below |
| Get Job | GET /api/science/jobs/{job_id} | See schema and notes below |
| Start | POST /api/science/workflow/discovery/start | See schema and notes below |
| Stop | POST /api/science/workflow/discovery/stop | See schema and notes below |
| Resume | POST /api/science/workflow/discovery/resume | See schema and notes below |
| Intermediates | POST /api/science/workflow/discovery/intermediates | See schema and notes below |
| Candidate Decision | POST /api/science/workflow/discovery/decision | See schema and notes below |
| Candidate Decisions | POST /api/science/workflow/discovery/decisions | See schema and notes below |
Start a selected panel
Use panel.json as an approved test example. Required fields are target_name, target_taxid, inclusions and exclusions. For the native panel workflow include pipeline_profile: "panel_review_v1", native_panel_required: true and specificity_provider: "aws_native". Its selected-reference scope uses global_blast: false; do not present this as a whole-database check.
review_goal is 1–50, default 3. It is a stopping goal, not permission to relax scientific criteria. Each inclusion/exclusion has a label and an accession, or an owned uploaded-reference structure. The example uses accessions only.
Follow a run
Start and resume return a job record with id. Read /api/science/jobs/{job_id} using that ID. Keep the original inputs, outer execution status and nested result.data.status. Resume produces a new linked attempt.
Read candidate evidence
Send job_id, offset (0–10000), limit (1–50) and optionally candidate_id to intermediates. Use detail_view: "checks" for bounded calculation evidence. The response includes candidates, total, offset, limit and job_status; a detailed candidate view may have a different shape.
Save and read a decision
Send job_id, candidate_id, decision, note and UUID decision_id to decision. Decision values are shortlisted, needs_changes, selected_for_lab or rejected. Notes are 1–4000 characters. Send job_id and candidate_id to decisions to read back the history.
Download the machine-readable contract
DimerIQ OpenAPI JSON. It is generated from the actual engine schema and mapped to the exposed public adapter routes. Some legacy response schemas are unconstrained; use the documented examples and treat omitted fields as unknown rather than fabricating values.
Authentication, errors, role enforcement and ownership are applied by the adapter and engine. Read errors and retries before adding automatic retries.