Skip to content
Developers
Get an API token

Delete unfinished plans

Deletes the queued and running plans that match in the request's tenant and model set, newest first, each as DELETE /plans/{id}?unless=saved does: a running plan stops after its chunks in flight, and a saved or shared plan stays, counted in kept.

Delete unfinished plans

DELETE/plans

Deletes the queued and running plans that match in the request's tenant and model set, newest first, each as DELETE /plans/{id}?unless=saved does: a running plan stops after its chunks in flight, and a saved or shared plan stays, counted in kept.

Send a Novi API token as a bearer token on every request. Authentication
Filters

status=running is required (a queued plan reads running), with at least one of created_by, created_from and created_to; each one sent narrows the match. A done or failed plan is never touched. Any other parameter is a 400, so a misspelt filter can't widen the delete.

Limits

One call deletes at most 200 plans; remaining counts the matches left, so call again until it is 0.

Parameters

Query parameters

  • statusstringRequired

    running: the queued and running plans. Missing or any other value is a 400.

    "running"
  • created_bystringOptional

    me: only the plans the request's user posted, matched on the stored email; older plans name no one and don't match. Reach another user's plans by created_from and created_to. Any other value is a 400: an email never goes in a URL.

    "me"
  • created_fromstringOptional

    Format date-time

    Only plans created at or after this date-time, such as 2026-11-12T00:00:00Z. One after created_to is a 400.

    Takes a date, YYYY-MM-DD, read as 00:00 UTC, or a date-time, YYYY-MM-DDTHH:MM[:SS] with optional fractional seconds (up to 9 digits, cut to the millisecond) and Z or a +HH:MM or -HH:MM offset. A day or time that doesn't exist, or any other form, is a 400.

  • created_tostringOptional

    Format date-time

    Only plans created at or before this date-time, such as 2026-11-12T06:00:00Z.

    Takes a date, YYYY-MM-DD, read as 00:00 UTC, or a date-time, YYYY-MM-DDTHH:MM[:SS] with optional fractional seconds (up to 9 digits, cut to the millisecond) and Z or a +HH:MM or -HH:MM offset. A day or time that doesn't exist, or any other form, is a 400.

  • model_setstringOptional

    pattern ^[a-z0-9][a-z0-9-]{0,62}$

    The model set to answer from, an id from GET /model-sets. Absent: the set GET /model-sets names as default, the base dataset unless the server answers from a published set.

    • model_set=default reaches the base dataset; once the server retires it, a 400 naming the set answering instead.
    • An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in details.allowed (published sets only once default is retired); a set that can't load, a 503 with the reason.
    • Plans and exports stay in their set: a call naming them (by path, plan, ids, source.plan, a scenario's plan.id, or a comparison's a.plan and b.plan, also under source.comparison) reaches it without model_set.
    • An explicit model_set wins; naming resources of two sets in one request is a 400.

Responses

200 OK

What was deleted, kept and left.

  • deletedintegerRequired

    ≥ 0

    Plans deleted by this call: ids counted.

  • keptintegerRequired

    ≥ 0

    Matching plans left because they are saved or shared.

  • remainingintegerRequired

    ≥ 0

    Matching plans not deleted: past the 200 one call deletes, or whose delete failed. Call again until it is 0.

  • idsarray of stringsRequired

    up to 200 items

    The deleted plans, newest first.

Errors

StatusWhen
404

No such well, grid, plan or route.

Shared errors400401403500503What they mean