API reference
Every endpoint, on one page.
Basics
| Details | |
|---|---|
| Base URL | https://api.usesigna.org/v1 |
| Authentication | Authorization: Bearer sk_live_… |
| Success | JSON answers come as {"success": true, "payload": …}; signs and videos come as files. |
| Errors | JSON with message and code. Errors and limits |
Endpoints
GET
/v1/api/me| Send | Get back | More |
|---|---|---|
— | Your organisation, limits and usage this month | Guide |
GET
/v1/languages| Send | Get back | More |
|---|---|---|
— | The spoken and signed language codes | Guide |
POST
/v1/sign| Send | Get back | More |
|---|---|---|
{"text", "from", "to"} | The signs, streamed a word at a time (.sgn) | Guide |
GET
/v1/spoken-to-signed-pose| Send | Get back | More |
|---|---|---|
?text&spoken&signed | The whole sentence as one .pose file | Guide |
POST
/v1/sign/video| Send | Get back | More |
|---|---|---|
.sgn or .pose body; ?skin&hair&shirt&pants&gender&age | An MP4 video | Guide |
POST
/v1/stt| Send | Get back | More |
|---|---|---|
multipart: audio, lang | {"text", "lang", "provider"} | Guide |
POST
/v1/tts| Send | Get back | More |
|---|---|---|
{"text", "lang", "speechRate"} | {"audio", "provider", "lang"} | Guide |
WSS
/v1/live| Send | Get back | More |
|---|---|---|
start message, then 16 kHz PCM | partial and final messages | Guide |
A JSON answer
{
"success": true,
"payload": { "signed": ["ksl", "ase", "fsl", "bfi", "jsl", "ils"], "spoken": ["rw", "fr", "en", "ja", "sw"] },
"timestamp": "2026-10-24T07:04:17.630Z"
}