API Reference

Public symbols at a glance.

This reference summarizes the current public API available through the Primordial SDK package product.

Activation

Quickstart

Primordial.checkIntegration()

Evaluation

Primordial.activate(.evaluationKey("pk_eval_..."))

Production

Primordial.activate(.license(.bundled("Primordial.license")))

Client And Configuration

PrimordialClient

integrationStatus()
localLLM(configuration:)
voiceModelManager()
voiceRecorder(localeIdentifier:modelManager:)

PrimordialConfiguration

defaultLLMConfiguration
defaultVoiceLocaleIdentifier

PrimordialIntegrationStatus

sdkVersion
platform
isSimulator

Local LLM

PrimordialMLXLLM

download
load
downloadAndLoad
generate
stream
unload
removeDownloadedModel

PrimordialMLXModelConfiguration

.qwen3_1_7B4Bit
.bonsai8B1Bit
maxTokens
temperature
capabilities

PrimordialLLMMessage

Chat input roles:

.system
.user
.assistant

Download And Generation Payloads

PrimordialLLMDownloadProgress

fractionCompleted
status
currentFilename
downloadedBytes
totalBytes
bytesPerSecond

PrimordialDownloadOptions

.default
.withoutStorageCheck
storageSafetyMarginFraction
minimumStorageSafetyMarginBytes

Generation Results

PrimordialLLMGenerationResult returns final text. PrimordialLLMGenerationChunk powers streaming.

Voice

PrimordialVoiceModelManager

download
load
downloadAndLoad
isReady
removeDownloadedModel

PrimordialVoiceRecorder

requestAuthorization
startRecording
stopRecording
pauseRecording
resumeRecording
updates

Voice Updates

PrimordialTranscriptionUpdate and PrimordialVoiceRecordingResult expose transcripts and captured audio.

Errors

PrimordialLLMError

modelNotDownloaded
modelNotLoaded
insufficientStorage
downloadFailed
generationFailed

PrimordialVoiceError

modelNotDownloaded
speechPermissionDenied
microphonePermissionDenied
audioCaptureFailed

PrimordialError

activationRequired
evaluationKeyInvalid
licenseMissing
licenseInvalidSignature
licenseWrongAppId
licenseExpired
featureNotLicensed