Repository navigation
Releases: MiViA-GmbH/MiViA-API-py
Releases · MiViA-GmbH/MiViA-API-py
Release list
mivia: v0.4.0
0.4.0 (2026-08-31)
⚠ BREAKING CHANGES
imageis an object, results moved underresult, and customization is{config, template}.job.resultsandimage_filenamestay available as properties. Adds get_jobs_status().
Features
- add get_recent_job_ids method and recent-ids CLI command (1abff4d)
- add list_all_jobs, enhance jobs list CLI with status filter and pagination (bdeefc9)
- add proxy support via MIVIA_PROXY env var and --proxy CLI option (898760d)
- admin-only inline customization override on create_jobs (3386abf)
- client: poll the async report endpoints (d46b34e)
- follow the reshaped jobs v2 response contract (078bdfe)
- initial commit (362d736)
Bug Fixes
- add startedAt/finishedAt to JobDto, handle empty customization (3e60dae)
- client: map 403 and 429 to typed errors (15b3079)
- client: parse plain array response from GET /jobs (120806e)
- client: report a cancelled report as such (f4b5604)
- client: take the queued status and surface the in-flight cap (b2dcb9d)
- resolve ruff lint and format issues in CLI (dc54cd5)
Miscellaneous Chores
- restore release-please config (0c0b1b5)
v0.3.1
v0.3.0
Features
- Admin-only inline customization override on
create_jobs. New parametercustomization_config_override: dict | Nonelets admin API keys override the resolved customization config for the created jobs only, without modifying the stored customization group. Non-admin callers receive 403 from the server. MiviaClient.get_resolved_customization_config(customization_id)— fetch the fully resolved baseline config (after parent merge) from/admin/customizations/groups/{id}/resolved-settings. Admin-only.mivia.deep_merge(base, patch)— exported helper. Recursive dict merge; lists and scalars in the patch replace. Inputs not mutated.- Sync mirrors on
SyncMiviaClient.
Usage
client = SyncMiviaClient() # admin API key
config = client.get_resolved_customization_config(customization_id)
config["thresholds"]["min_area"] = 0.05
client.create_jobs(
image_ids=[...], model_id=..., customization_id=customization_id,
customization_config_override=config,
)Requires the corresponding server change (customizationConfigOverride on POST /jobs).
v0.2.0
What's New
Features
list_all_jobs()— list all jobs with auto-pagination and status filteringget_recent_job_ids()— get job IDs created within a duration (e.g.1h,2d)mivia jobs list— enhanced with--all,--status,--model(by name), duration columnmivia jobs recent-ids— new CLI command, one ID per line (pipeable)
Fixes
- Add
startedAt/finishedAtfields toJobDto - Handle empty customization dict in API response