curl --request POST \
--url https://app.vumasign.com/api/v1/templates/{templateId}/naming-runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"use_ai": false
}
'import requests
url = "https://app.vumasign.com/api/v1/templates/{templateId}/naming-runs"
payload = { "use_ai": False }
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({use_ai: false})
};
fetch('https://app.vumasign.com/api/v1/templates/{templateId}/naming-runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/templates/{templateId}/naming-runs"
payload := strings.NewReader("{\n \"use_ai\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "01960000-0000-4000-8000-0000000000a1",
"status": "queued",
"template_etag": "\"5c1f0e3a…\""
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}Ask Vumasign to name a template’s fields: a naming run, produced in the background.
NAMING, WITHOUT THE EDITOR. Queues a naming run over the template: Vumasign proposes a key for each field and question it can, an option value for each box, and a decision for each person on the form, with reasons. It writes nothing to the template. A run already waiting for this template as it stands, asking the same, is answered instead of queuing a second. A run is produced within a minute or two; read it with GET …/naming-runs/{runId}, or wait for the template.named webhook, then accept what you want with POST …/naming-runs/{runId}/accept.
⚠️ templates:name IS EXPLICIT-ONLY, AND LIVE KEYS ONLY, and the key’s creator must still be a member: a template has no environment.
curl --request POST \
--url https://app.vumasign.com/api/v1/templates/{templateId}/naming-runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"use_ai": false
}
'import requests
url = "https://app.vumasign.com/api/v1/templates/{templateId}/naming-runs"
payload = { "use_ai": False }
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({use_ai: false})
};
fetch('https://app.vumasign.com/api/v1/templates/{templateId}/naming-runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/templates/{templateId}/naming-runs"
payload := strings.NewReader("{\n \"use_ai\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "01960000-0000-4000-8000-0000000000a1",
"status": "queued",
"template_etag": "\"5c1f0e3a…\""
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}Authorizations
Authorization: Bearer vsk_live_…. Chosen over a bespoke X-API-KEY header because every client, proxy and log-redaction rule already knows this one. What a key may DO is its scopes — see x-scopes at the root of this document and x-required-scope on each operation. The scope list is not written here because OpenAPI reserves a requirement’s scope array for oauth2 and openIdConnect and requires it to be empty for an http scheme.
Headers
Any string that identifies this request, at most 255 characters. ⚠️ REQUIRED: retrying with the same key returns the same run rather than starting a second one. The caller’s own request identifier.
"01960000-0000-4000-8000-00000000ffff"
Path Parameters
The template’s id, as returned by the list endpoint.
A template id.
"01960000-0000-4000-8000-0000000007e1"
Body
Whether to use a model, and the blank-form confirmation that needs. Optional.
How to name it.
Ask for Stage 2, a model naming what the vocabulary cannot. Default false: Stage 1 only, which matches printed labels against the core vocabulary and your organisation’s keys. Stage 2 is not yet available, so a run asked for it is Stage 1 only, and its preview says ai_refused: "stage2_unavailable".
Required, as true, whenever use_ai is: you confirm the template is a blank form, with nobody’s details filled in, before its printed text is sent to a model.