Currixa.
Book a demo

First outcome in seven steps

From an API key to a provenance-documented read.

Documentation sections

Warning

Never put a key in code, in the repository, or in the browser — a server-side environment variable only. If one leaks, revoke it from the Developers page at once.

Steps

  1. Create an application

    In your workspace, open Developers, create an application and choose the read scopes it needs. Organisations the operator runs keep their service client.

  2. Take a key and keep it secret

    Create a test key first: it reads public content only, ten requests a minute. Then a live key. A key is shown once: put it in CURRIXA_API_KEY, a server-side environment variable, separate for development and production.

  3. Know your tenant

    A key belongs to one organisation; every read is evaluated inside it and never crosses to another.

  4. Pick scopes

    Ask for the minimum: curriculum:read for lists, outcome:read for outcomes, evidence:read for evidence.

  5. List the frameworks

    GET /v1/frameworks returns the frameworks your key can read, each with its latest published version, its grades and where it applies.

    GET /v1/frameworks
    export CURRIXA_API_KEY="paste-your-key-here"
curl -s -H "Authorization: Bearer $CURRIXA_API_KEY" "https://api.currixa.net/v1/frameworks"

  6. Read a framework's outcomes

    Pass version as YYYY.N or the full YYYY.N.P; the response always returns the resolved version.

    GET /v1/framework-outcomes
    curl -s -H "Authorization: Bearer $CURRIXA_API_KEY" "https://api.currixa.net/v1/framework-outcomes?framework=CURRIXA-ARA-NATIVE-V1&limit=5"

    framework takes a code from the list above, such as CURRIXA-ARA-NATIVE-V1; send page.next_cursor back as cursor for the next page.

  7. Follow provenance

    Every outcome carries source_ref; verify edition and locator before showing content to your users.

Issuance and limits

Your plan sets your requests a minute and a month (see the pricing page); a test key has its own 10 a minute. Exceeding any limit is a 429 with Retry-After.

Limits page