Access and keys
The API is for businesses and broadcasters. Every plan is agreed with you, and comes with keys and monthly limits.
Getting access
- Contact us with what you want to build and roughly how much: how many words a month, how many hours of live signing, how many videos.
- Most start with a trial: about a month with modest limits, to try Signa on your own content.
- We agree your plan, and you get live keys with the limits of your plan.
Using a key
Send it as a bearer token on every request:
curl https://api.usesigna.org/v1/api/me \
-H "Authorization: Bearer $SIGNA_KEY"| Key | Meaning |
|---|---|
sk_live_… | A live key, with the limits of your plan. |
sk_trial_… | A trial key. It stops working on the trial's end date. |
You can have several keys, for example one per product, station or environment, all counting against the same plan. Ask us for another at any time. For web pages and apps, never use the key itself: use client tokens.
We can't show a key twice
Monthly limits
Your plan sets up to three monthly limits. A limit that is not set means no limit.
| Limit | What counts |
|---|---|
| Characters | The characters of every text you sign, through /v1/sign or onto an overlay. |
| Live minutes | Time connected to /v1/live. |
| Videos | Every video made with /v1/sign/video. |
Subtitles are counted too, as minutes of audio, for your invoice; they have no separate limit unless your plan sets one.
| Also counted | What |
|---|---|
| Subtitle minutes | The length of every file sent to /v1/subtitles. |
| Requests | Every call, for your own records. |
Months are calendar months in UTC. When a limit is reached, requests that need it are refused with 429 API_LIMIT_REACHED until the 1st, or until we raise it. Errors and limits.