API Documentation

1. Get an API key

Go to Settings → API Keys and create a new key with upload and documents:read scopes.

2. Initialize an upload

curl -X POST https://api.trueaccessibility.com/api/upload/init \
  -H "X-API-Key: ta_sk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "filename": "report.pdf",
    "fileSize": 1024000,
    "contentType": "application/pdf"
  }'

This returns a uploadUrl (presigned S3 URL) and documentId. Upload your file to the presigned URL with a PUT request.

3. Complete the upload

curl -X POST https://api.trueaccessibility.com/api/upload/complete \
  -H "X-API-Key: ta_sk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"documentId": "DOCUMENT_ID"}'

Processing starts automatically. Poll GET /api/documents/DOCUMENT_ID to check status, or set up a webhook.

4. Download the accessible PDF

curl https://api.trueaccessibility.com/api/documents/DOCUMENT_ID/download \
  -H "X-API-Key: ta_sk_your_api_key_here"

Returns a presigned URL to download the WCAG 2.2 / PDF/UA-1 compliant PDF.

cURL -- Upload and remediate a document

# 1. Initialize upload
INIT=$(curl -s -X POST https://api.trueaccessibility.com/api/upload/init \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filename":"report.pdf","fileSize":'$(stat -f%z report.pdf)',"contentType":"application/pdf"}')

UPLOAD_URL=$(echo $INIT | jq -r '.uploadUrl')
DOC_ID=$(echo $INIT | jq -r '.documentId')

# 2. Upload the file to S3
curl -X PUT "$UPLOAD_URL" \
  -H "Content-Type: application/pdf" \
  --data-binary @report.pdf

# 3. Signal upload complete (triggers processing)
curl -X POST https://api.trueaccessibility.com/api/upload/complete \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"documentId":"'$DOC_ID'"}'

# 4. Poll status until completed
curl -s https://api.trueaccessibility.com/api/documents/$DOC_ID \
  -H "X-API-Key: $API_KEY" | jq '.status'

# 5. Download the remediated file
curl -s https://api.trueaccessibility.com/api/documents/$DOC_ID/download \
  -H "X-API-Key: $API_KEY" | jq -r '.url'

JavaScript / Node.js

const API_KEY = 'ta_sk_your_api_key_here';
const BASE_URL = 'https://api.trueaccessibility.com/api';

const headers = {
  'X-API-Key': API_KEY,
  'Content-Type': 'application/json',
};

// 1. Initialize upload
const initRes = await fetch(`${BASE_URL}/upload/init`, {
  method: 'POST',
  headers,
  body: JSON.stringify({
    filename: 'report.pdf',
    fileSize: fileBuffer.byteLength,
    contentType: 'application/pdf',
  }),
});
const { documentId, uploadUrl } = await initRes.json();

// 2. Upload file to presigned URL
await fetch(uploadUrl, {
  method: 'PUT',
  headers: { 'Content-Type': 'application/pdf' },
  body: fileBuffer,
});

// 3. Signal upload complete
await fetch(`${BASE_URL}/upload/complete`, {
  method: 'POST',
  headers,
  body: JSON.stringify({ documentId }),
});

// 4. Poll until complete
let status = 'detecting';
while (!['completed', 'failed'].includes(status)) {
  await new Promise(r => setTimeout(r, 5000));
  const res = await fetch(`${BASE_URL}/documents/${documentId}`, { headers });
  const doc = await res.json();
  status = doc.status;
  console.log(`Status: ${status} (${doc.progress || 0}%)`);
}

// 5. Download result
const dlRes = await fetch(`${BASE_URL}/documents/${documentId}/download`, { headers });
const { url } = await dlRes.json();
console.log('Download URL:', url);

Register a webhook

curl -X POST https://api.trueaccessibility.com/api/webhooks \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhook",
    "events": ["document.completed", "document.failed"]
  }'