outfigure

The Python client for the OutFigure API.

OutFigure keeps three things apart for a learning platform: what a learner did with help, what they did without it, and whether a change to the teaching moved the second. This package sends your learning events and outcomes to the API and reads back evidence, learner states and Outcome Receipts.

The hosted API is a sandbox for invited partners, with test data only. To ask about a pilot, write to hello@outfigure.in.

Install

pip install outfigure

Python 3.11 or later. The client uses the standard library only, so it brings no other packages with it. Use it on your server: an API key never belongs in a browser.

Send an event and read the evidence

import os
from datetime import datetime, timezone

from outfigure import OutFigure

client = OutFigure(
    api_key=os.environ["OUTFIGURE_API_KEY"],
    base_url="https://console.outfigure.in",
)

receipt = client.events.send(
    {
        "schema_version": "1.0",
        "event_id": "evt_demo_0001",
        "event_type": "response",
        "learner_id": "learner_demo_01",
        "occurred_at": datetime.now(timezone.utc).isoformat(),
        "source": "partner_backend",
        "session_id": "session_demo_01",
        "item_id": "question_012",
        "item_version": "1",
        "attempt_id": "attempt_demo_01",
        "attempt_number": 1,
        "response_kind": "binary",
        "correct": True,
        "assistance": "none",
        "hint_count": 0,
        "feedback_seen": False,
    },
    idempotency_key="demo-send-0001",
)

client.jobs.wait(receipt["job_ids"], timeout=15)
state = client.learners.state("learner_demo_01")

One response is thin evidence. A learner's state on a concept stays insufficient_evidence until it has at least five eligible attempts across two sessions, and missing data is never turned into a score.

How it behaves

• Fields use the API's own names (learner_id, item_version), and requests and responses are typed as TypedDicts in outfigure.types.
• Network failures and 429, 502, 503 and 504 are retried at most three times, with the same body and idempotency key, honouring Retry-After. Other errors are raised as ApiError with the code, status and request ID.
• No telemetry, no background work, no local copy of learner data.

The full reference, with every route and scope, is at outfigure.in/developers.

Licence

MIT. This covers the client only; the OutFigure service is not open source.