Quickstart

Fire your first authenticated request against the Signus API in five minutes.

Get your credentials

You need two things from Settings → Developer in the Signus app :

Your API key — a secret shown once when you create it.
Your Account ID — a UUID shown at the top of the Developer page.

Export them so the snippets below pick them up:


export SIGNUS_API_KEY="sk_..."
export SIGNUS_ACCOUNT_ID="ed62df3d-94f8-4f1f-995e-30324dc4a82e"

Clone the sample project (optional but recommended)

The fastest way to get something working end-to-end is the Node.js example repo:


git clone https://github.com/signus-team/signus-api-nodejs-example.git
cd signus-api-nodejs-example
cp .env.example .env   # paste your API key and Account ID
npm install
npm start

Or make a request directly

Here’s the simplest possible authenticated call — list your templates. It’s the same request the Test API key dialog in the Signus app fires.

Node.js (fetch)


const res = await fetch(
  `https://api.signus.ai/v1/accounts/${process.env.SIGNUS_ACCOUNT_ID}/templates?pageIndex=0&pageSize=5`,
  {
    headers: {
      Authorization: `Bearer ${process.env.SIGNUS_API_KEY}`,
      'Content-Type': 'application/json',
    },
  },
);
 
const data = await res.json();
console.log(data);

Node.js (axios)


import axios from 'axios';
 
const { data } = await axios.get(
  `https://api.signus.ai/v1/accounts/${process.env.SIGNUS_ACCOUNT_ID}/templates`,
  {
    params: { pageIndex: 0, pageSize: 5 },
    headers: { Authorization: `Bearer ${process.env.SIGNUS_API_KEY}` },
  },
);
 
console.log(data);

cURL


curl "https://api.signus.ai/v1/accounts/$SIGNUS_ACCOUNT_ID/templates?pageIndex=0&pageSize=5" \
  -H "Authorization: Bearer $SIGNUS_API_KEY" \
  -H "Content-Type: application/json"

A 200 response with a JSON page of templates means everything is wired up correctly. A 401 means the API key is wrong; a 403 typically means API access isn’t enabled for your workspace. The full endpoint catalog is in the Swagger reference .

Once you’re authenticated, you’ll almost certainly want to react to document lifecycle events — use webhooks rather than polling.