Skip to main content

Documents API

Manage transcripts and captions created from batch transcriptions.

Overview​

The Documents API allows you to:

  • List and search documents
  • Retrieve document content
  • Update document metadata
  • Export to multiple formats
  • Translate documents
  • Share documents via magic links
  • Delete documents

Document Types​

TypeDescription
transcriptText transcript with timestamps
captionSubtitle file (SRT, VTT, etc.)

Base Endpoint​

/api/v3/documents

Quick Start​

List Documents​

curl https://api.scriptix.io/api/v3/documents \
  -H "Authorization: Bearer YOUR_API_KEY"

Get Document​

curl https://api.scriptix.io/api/v3/documents/123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Update Document​

curl -X PATCH https://api.scriptix.io/api/v3/documents/123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated Meeting Notes"}'

Export Document​

curl -X POST https://api.scriptix.io/api/v3/documents/123/export \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"format": "srt"}'

Document Object​

{
  "id": 123,
  "name": "Team Meeting January 2025",
  "type": "transcript",
  "language": "en",
  "duration_seconds": 3600,
  "status": "completed",
  "created_at": "2025-01-17T10:00:00Z",
  "updated_at": "2025-01-17T15:30:00Z",
  "content": {
    "text": "Full transcript text...",
    "segments": [
      {
        "start": 0.0,
        "end": 2.5,
        "text": "Hello, welcome to the meeting.",
        "speaker": "Speaker 1"
      }
    ]
  }
}

Features​

Search & Filter​

Filter documents by status, language, type, date range.

Export Formats​

  • Plain text (.txt)
  • Microsoft Word (.docx)
  • PDF (.pdf)
  • SRT subtitles (.srt)
  • VTT subtitles (.vtt)
  • JSON

Translation​

Translate transcripts to 30+ languages.

Sharing​

Create magic links for sharing documents publicly.

Version History​

Track changes and restore previous versions.

API Endpoints​

MethodEndpointDescription
GET/api/v3/documentsList documents
GET/api/v3/documents/{id}Get document
POST/api/v3/documentsCreate document
PATCH/api/v3/documents/{id}Update document
DELETE/api/v3/documents/{id}Delete document
POST/api/v3/documents/{id}/exportExport document
POST/api/v3/documents/{id}/translateTranslate document
POST/api/v3/documents/{id}/shareCreate share link
PATCH/api/v3/documents/{id}/statusChange status

Document Status​

StatusDescription
draftIn progress, not finalized
reviewReady for review
completedFinalized and approved
archivedArchived for storage

Best Practices​

1. Use Pagination​

docs = requests.get(
    'https://api.scriptix.io/api/v3/documents',
    params={'per_page': 100}
).json()

2. Filter Results​

docs = requests.get(
    'https://api.scriptix.io/api/v3/documents',
    params={'status': 'completed', 'language': 'en'}
).json()

3. Cache Document Content​

Documents don't change frequently - cache them.

Next Steps​