Skip to content
DecisionNodeDecisionNdedocs
  • Guides
  • API reference
  • Examples
  • Playground

start here

  • QuickstartGet startedGet an API key, send one request with three questions, and branch your code on the typed answers. Plain HTTPS, nothing to install.
  • POST /v1/decideAPI referenceAnswer typed questions about a state, optional images and video frames. One request, one buffered JSON response, one answer per question.
  • QuestionsConceptsQuestions say what to decide. Each one has a type that fixes the shape of its answer: a choice from your options, a score on your scale, a…
  • ConfidenceConceptsProbabilities are calibrated per question type, so a threshold means what it says on the data we measure.
  • ImagesConceptsSend up to 16 images and text in the same request. The model reads printed and handwritten text, amounts, dates, objects and layout, and…
  • Batch jobsPatternsSend up to 10,000 requests in one file and collect the answers later, at a lower price than live calls.
  • Pricing and billingEvery workspace runs on a plan: Starter, Pro, Business or Dedicated.
↑↓ moveopen7 suggestions
Get API keyGet API key
DecisionNodeDecisionNde

Get started

  • Introduction
  • Quickstart
  • CLI
  • Playground
  • Console and keys
  • With coding agents
  • MCP server
  • Examples

Concepts

  • State
  • Questions
  • Choice
  • Score
  • Truth
  • Number
  • Points and boxes
  • Images
  • Video
  • Boosters
  • Collections
  • Confidence
  • Determinism
  • API keys

Knowledge

  • Overview
  • Documents
  • In a decision
  • Pricing and your data
  • When a rule does not appear

Models

  • DecisionNode
  • DecisionNode Flash
  • DecisionNode Edge
  • Limits
  • Versions
  • Dedicated capacity

Fine-tuning

  • Overview
  • Prepare your dataset
  • Upload and validation
  • Start a training run
  • Watch a run
  • The quality gate
  • Use your model
  • Limits and pricing

Patterns

  • Confidence-gated routing
  • Form router
  • Fan-out
  • Guardrails
  • Control loops
  • Batch jobs
  • Keys on devices
  • Bill your customers per device
  • Publishable keys

Integrations

  • Home Assistant
  • MQTT bridge
  • ROS 2

API reference

  • Overview
  • POST/v1/decide
  • POST/v1/systemone
  • GET/v1/models
  • POST/v1/uploads
  • /v1/keys
  • GET/v1/keys/{key_id}/usage
  • GET/v1/usage
  • POST/v1/credit
  • Errors
  • Safety check
  • Rate limits

Sessions API

  • Sessions overview
  • POSTOpen a session
  • WSStream frames
  • DELEnd a session

Collections API

  • Overview
  • POSTCreate a collection
  • GETList collections
  • GETRetrieve a collection
  • DELDelete a collection
  • POSTEnroll a face
  • GETList items
  • PATCHUpdate an item
  • DELDelete an item
  • POSTAdd a document
  • PUTReplace a document
  • GETRetrieve an item
  • GETList passages
  • DELDelete failed documents
  • POSTSearch a knowledge base

Batch API

  • The batch object
  • POSTCreate a batch
  • POSTAdd requests
  • POSTFinalize a batch
  • GETRetrieve a batch
  • GETGet batch results
  • POSTCancel a batch
  • GETList batches

Pricing and billing

  • Pricing and billing
  • Refer & earn

Policies

  • Responsible use
  • Data and privacy
  • Benchmarks
  • Pricing
  • Playground
Get API key
  • Guides
  • API reference
  • Examples
  • Playground

Get started

  • Introduction
  • Quickstart
  • CLI
  • Playground
  • Console and keys
  • With coding agents
  • MCP server
  • Examples

Concepts

  • State
  • Questions
  • Choice
  • Score
  • Truth
  • Number
  • Points and boxes
  • Images
  • Video
  • Boosters
  • Collections
  • Confidence
  • Determinism
  • API keys

Knowledge

  • Overview
  • Documents
  • In a decision
  • Pricing and your data
  • When a rule does not appear

Models

  • DecisionNode
  • DecisionNode Flash
  • DecisionNode Edge
  • Limits
  • Versions
  • Dedicated capacity

Fine-tuning

  • Overview
  • Prepare your dataset
  • Upload and validation
  • Start a training run
  • Watch a run
  • The quality gate
  • Use your model
  • Limits and pricing

Patterns

  • Confidence-gated routing
  • Form router
  • Fan-out
  • Guardrails
  • Control loops
  • Batch jobs
  • Keys on devices
  • Bill your customers per device
  • Publishable keys

Integrations

  • Home Assistant
  • MQTT bridge
  • ROS 2

API reference

  • Overview
  • POST/v1/decide
  • POST/v1/systemone
  • GET/v1/models
  • POST/v1/uploads
  • /v1/keys
  • GET/v1/keys/{key_id}/usage
  • GET/v1/usage
  • POST/v1/credit
  • Errors
  • Safety check
  • Rate limits

Sessions API

  • Sessions overview
  • POSTOpen a session
  • WSStream frames
  • DELEnd a session

Collections API

  • Overview
  • POSTCreate a collection
  • GETList collections
  • GETRetrieve a collection
  • DELDelete a collection
  • POSTEnroll a face
  • GETList items
  • PATCHUpdate an item
  • DELDelete an item
  • POSTAdd a document
  • PUTReplace a document
  • GETRetrieve an item
  • GETList passages
  • DELDelete failed documents
  • POSTSearch a knowledge base

Batch API

  • The batch object
  • POSTCreate a batch
  • POSTAdd requests
  • POSTFinalize a batch
  • GETRetrieve a batch
  • GETGet batch results
  • POSTCancel a batch
  • GETList batches

Pricing and billing

  • Pricing and billing
  • Refer & earn

Policies

  • Responsible use
  • Data and privacy
  1. docs
  2. /
  3. Models

Versions and retirement

Family ids move to each new release; pinned ids never change. A pinned version stays available for at least 12 months after its successor ships, and you get at least 12 months' notice before it retires.

on this page8 sections
  1. Family ids and pinned ids
  2. How long a version lives
  3. After a version retires
  4. Moving to a new version
  5. Read what changed
  6. Replay your own requests
  7. Re-tune your thresholds
  8. Switch the pinned id
  • DecisionNode

    Family id you send as model (moves)
    decisionnode
    Version, a pinned id (never changes)
    decisionnode-main-0.9.1-rc1
  • DecisionNode Flash

    Family id you send as model (moves)
    decisionnode-flash
    Version, a pinned id (never changes)
    decisionnode-flash-0.9.1-rc1
Family ids and versions today
ModelFamily id you send as model (moves)Version, a pinned id (never changes)
DecisionNodedecisionnodedecisionnode-main-0.9.1-rc1
DecisionNode Flashdecisionnode-flashdecisionnode-flash-0.9.1-rc1

Family ids and pinned ids#

Two words, used the same way on every page: the family id is the model you send (what the Terms of Service call an alias), and the version is the pinned id the response names. You may also send a version as model, to pin it.

  • A family id such as decisionnode answers from its family's current version, the one GET /v1/models names. It moves when we release a version, without notice. During a rollout, while the servers move to a new version, a request may be answered by any version a server of the family reports, so answers can change on the day of a release.
  • A pinned id such as decisionnode-main-0.9.1-rc1 answers from exactly that version for as long as it is available. The same request gets the same answer every time. See Determinism.
  • Every response names exactly the version that answered: model in the body and x-decisionnode-model in the headers, whichever id you sent, during a rollout too.
  • GET /v1/models lists each family id with the pinned version it answers from today, and each pinned version being served with its family as alias.

Earlier names still work as aliases: decisionnode-1.0 and decisionnode-latest for decisionnode; decisionnode-1.0-flash and decisionnode-flash-latest for decisionnode-flash. They answer as the family's current release; send the family ids in new code.

Pin in production

Send the family id while you build and test. Ship with the pinned id wherever a threshold is tuned, a decision is audited or a test asserts an answer, and move to a new version on purpose, with the steps below.

How long a version lives#

  • A pinned version stays available

    Value
    At least 12 months after its successor is released
  • Notice before a pinned version retires

    Value
    At least 12 months
  • How notice is given

    Value
    In the console and by email to your account's contact
  • Evaluation and calibration results

    Value
    We aim to publish them with each new version, before you switch to it
Version support
CommitmentValue
A pinned version stays availableAt least 12 months after its successor is released
Notice before a pinned version retiresAt least 12 months
How notice is givenIn the console and by email to your account's contact
Evaluation and calibration resultsWe aim to publish them with each new version, before you switch to it

The binding commitment is section 3.3 of the Terms of Service. A version may be withdrawn sooner only where the law, security or the prevention of harm requires it.

After a version retires#

A call that names a retired pinned id gets 400, with the body every unknown model name gets; nothing is billed. A family id is not retired with a version: it moves to the current one. A batch that names a retired pinned id is refused when you finalize it, with the same error, so move your batch files to the new id with your live code.

400
{
  "detail": {
    "error_type": "api_usage_error",
    "message": "Unknown model: decisionnode-main-0.9.1-rc1"
  }
}

Moving to a new version#

  1. 1

    Read what changed#

    Each release lists its evaluation and calibration results. Check the suites closest to your work on the Benchmarks page.

  2. 2

    Replay your own requests#

    Send requests you have kept with known outcomes to your current pinned id and to the new one, and compare. The program below counts the top answers that change: the choice, the score's nearest level, a truth on the other side of your cut-off, or the number.

    import json, os, requests
    
    KEY = os.environ["DECISIONNODE_API_KEY"]
    HEADERS = {"Authorization": f"Bearer {KEY}"}
    CURRENT = "decisionnode-main-0.9.1-rc1"  # the pinned id your code sends today
    
    
    def decide(body: dict, model: str) -> dict:
        r = requests.post(
            "https://api.decisionnode.com/v1/decide",
            json={**body, "model": model},
            headers=HEADERS,
            timeout=10,
        )
        r.raise_for_status()
        return r.json()
    
    
    # the version the family id answers from now
    listed = requests.get("https://api.decisionnode.com/v1/models", headers=HEADERS, timeout=10)
    models = listed.json()["models"]
    candidate = next(m["version"] for m in models if m["name"] == "decisionnode")
    
    TRUE_AT = 0.5  # the cut-off your code acts at on truth answers
    
    
    def top(answer: dict):
        """What your code acts on: the choice, the level, true or false, the value."""
        kind = answer["type"]
        if kind == "choice":
            return answer["choice"]
        if kind == "score":
            return round(answer["score"])
        if kind == "number":
            return answer["number"]
        return answer["truth"] >= TRUE_AT
    
    
    # replay requests you have kept with known outcomes, one per line: {"request": {...}}
    changed = 0
    with open("labelled.jsonl") as f:
        for line in f:
            if not line.strip():
                continue
            case = json.loads(line)
            old = decide(case["request"], CURRENT)["answers"]
            new = decide(case["request"], candidate)["answers"]
            changed += sum(top(new[key]) != top(old[key]) for key in new)
    print(f"{candidate}: {changed} top answers differ from {CURRENT}")
  3. 3

    Re-tune your thresholds#

    Probabilities are calibrated per version, so the same cut-off can act on a different share of traffic. Re-pick each threshold on the new version from your replay, the way you first chose it. See Confidence.

  4. 4

    Switch the pinned id#

    Change the id in config with the new thresholds, in one change, so a rollback restores both. Keep the old id until its retirement date for that rollback.

Sessions and batches

A session answers every frame from the version its model named when it opened. A batch line names its own model as a live call does, so a file of pinned ids keeps its answers fixed.

previousLimitsnextDedicated capacity

DecisionNode is built and run by Bynn Intelligence, Inc.

  • Home
  • Playground
  • Examples
  • Console
  • Responsible use
  • Terms
  • Acceptable use
  • Privacy
  • Data processing
  • Defence addendum
  • Cookies
  • Affiliate program

on this page

  1. Family ids and pinned ids
  2. How long a version lives
  3. After a version retires
  4. Moving to a new version
  5. Read what changed
  6. Replay your own requests
  7. Re-tune your thresholds
  8. Switch the pinned id