SDKGet started
Last updated on October 23, 2026
Your own guide
Get a guide written for your company, with your platforms, your functions and an example call for each.
What the guide is
One page, written for your company. It covers:
- install and the key
- connecting an end customer to each platform switched on for you
post,pullandrun- every one of your functions, with its fields and an example call that works as written
- every error, with what to do about it
It is markdown, built from what is live for you right now. Get it again whenever a function goes live.
Get the guide
From the command line:
npx appnigma guideIt reads your key from APPNIGMA_SDK_KEY, or from --key, and writes appnigma-guide.md in the current folder, or wherever --out says.
From a program, appnigma.guide() answers { guide }, the same markdown.
guide answers the markdown:
File.write("appnigma-guide.md", client.guide[:guide])guide answers the markdown:
from pathlib import Path
Path("appnigma-guide.md").write_text(client.guide()["guide"])