Vault — Document Status
curl --request GET \
--url https://api.eu.linqalpha.com/v2/vault/status \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.eu.linqalpha.com/v2/vault/status"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.eu.linqalpha.com/v2/vault/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eu.linqalpha.com/v2/vault/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.eu.linqalpha.com/v2/vault/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.eu.linqalpha.com/v2/vault/status")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eu.linqalpha.com/v2/vault/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"statuses": [
{
"rms_document_id": "eeb72343-d883-41a3-a58c-533184bbb9fd",
"name": "Q4_report.pdf",
"status": "Synced",
"fail_code": null
}
]
}Analytics V2
Vault — Document Status
Returns the processing status for one or more vault documents. Poll after confirm until status is Synced (complete and searchable).
GET
/
v2
/
vault
/
status
Vault — Document Status
curl --request GET \
--url https://api.eu.linqalpha.com/v2/vault/status \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.eu.linqalpha.com/v2/vault/status"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.eu.linqalpha.com/v2/vault/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eu.linqalpha.com/v2/vault/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.eu.linqalpha.com/v2/vault/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.eu.linqalpha.com/v2/vault/status")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eu.linqalpha.com/v2/vault/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"statuses": [
{
"rms_document_id": "eeb72343-d883-41a3-a58c-533184bbb9fd",
"name": "Q4_report.pdf",
"status": "Synced",
"fail_code": null
}
]
}Returns the processing status for one or more vault documents. Poll this after
Each entry also returns
confirm until status is Synced (complete and searchable), or to re-check documents later.
Status values
status | Meaning |
|---|---|
Synced | Complete and searchable — poll until this. |
Syncing... | Still processing. |
Syncing Failed | Processing failed. |
For link-swapped formats (audio, legacy Office), the status stays
Syncing... until the converted/transcript artifact is ready — so Synced always means usable, with no separate readiness flag.fail_code — a deterministic terminal-failure code (e.g. PASSWORD_PROTECTED, FILE_SIZE_EXCEEDED, CONVERSION_FAILED) so you can branch on the reason instead of parsing the status text. It is null unless the document terminally failed.
curl --request GET \
--url 'https://api.eu.linqalpha.com/v2/vault/status?rms_document_ids=eeb72343-...,3a0e9e69-...' \
--header 'X-API-KEY: <api-key>'
rms_document_ids is a comma-separated list of rms_document_id values (the rms_document_id returned by confirm), max 100.Use rms_document_id, not the presign document_id. The two are different identifiers — see Confirm Upload for their roles. Passing the presign document_id here returns no match.Authorizations
Query Parameters
Comma-separated list of rms_document_id values (the rms_document_id returned by confirm — NOT the presign document_id). Max 100.
Organization ID (optional).
User id (optional).
User email (optional).
User name (optional).
Response
Per-document status
Show child attributes
Show child attributes