JavaScript SDK - API Reference

// List interactions (paginated)
const page = await client.interactions.list({ limit: 10 });
for await (const interaction of page) {
    console.log(interaction.interactionId);
}

// Create a new interaction
const { interactionId } = await client.interactions.create({
    encounter: {
        identifier: "my-encounter-id",
        status: "planned",
        type: "first_consultation",
    },
});

// Get a specific interaction
const interaction = await client.interactions.get(interactionId);

// Update an interaction
await client.interactions.update(interactionId, {
    encounter: { status: "in-progress" },
});

// Delete an interaction
await client.interactions.delete(interactionId);

// --- Templates ---

// List templates (with optional filters)
const templates = await client.documents.templates.list({
    lang: ["en"],
    published: true,
});

// Create a template from scratch
const template = await client.documents.templates.create({
    name: "My Template",
    description: "Custom SOAP note",
    lang: "en",
    sections: [{ sectionId: "<section-uuid>", order: 0 }],
});

// Get / update / delete a template
const tmpl = await client.documents.templates.get(templateId);
await client.documents.templates.update(templateId, { name: "Renamed" });
await client.documents.templates.delete(templateId);

// --- Template Versions ---

const versions = await client.documents.templates.versions.list(templateId);
const version = await client.documents.templates.versions.create(templateId, {
    sections: [{ sectionId: "<section-uuid>", order: 0 }],
});
await client.documents.templates.versions.publish(templateId, versionId);
await client.documents.templates.versions.delete(templateId, versionId);

// --- Sections ---

const sections = await client.documents.sections.list({ lang: ["en"] });
const section = await client.documents.sections.create({
    name: "HPI",
    generation: {
        heading: "History of Present Illness",
        instructions: { contentPrompt: "Summarize the patient history" },
        outputSchema: { type: "string" },
    },
});
await client.documents.sections.update(sectionId, { name: "Renamed" });
await client.documents.sections.delete(sectionId);

// --- Section Versions ---

const sectionVersions = await client.documents.sections.versions.list(sectionId);
await client.documents.sections.versions.publish(sectionId, versionId);

// --- Generate ---

const result = await client.documents.generate({
    outputLanguage: "en-US",
    interactionId: "<interaction-uuid>",
    templateRef: { templateId: "<template-uuid>" },
});

// List / get / update / delete persisted documents
const documents = await client.documents.list();
const doc = await client.documents.get(documentId);
await client.documents.update(documentId, { name: "Renamed" });
await client.documents.delete(documentId);

// Generate a document
const { id: documentId } = await client.documents.classic.create(interactionId, {
    context: [{
        type: "string",
        data: "Patient presents with chest pain...",
    }],
    templateKey: "corti-soap",
    outputLanguage: "en",
});

// List documents for an interaction
const documents = await client.documents.classic.list(interactionId);

// Get a specific document
const doc = await client.documents.classic.get(interactionId, documentId);

// Update a document
await client.documents.classic.update(interactionId, documentId, {
    name: "Updated note",
});

// Delete a document
await client.documents.classic.delete(interactionId, documentId);

// Extract facts from text (standalone, no interaction needed)
const extracted = await client.facts.extract({
    context: [{ type: "text", text: "Patient has a temperature of 38.5°C and reports headache." }],
    outputLanguage: "en",
});

// List facts for an interaction
const facts = await client.facts.list(interactionId);

// Create facts on an interaction
const { id: factId } = await client.facts.create(interactionId, {
    facts: [{ text: "Temperature 38.5°C", group: "vitals" }],
});

// Batch update facts
await client.facts.batchUpdate(interactionId, {
    facts: [{ factId, text: "Temperature 39.0°C" }],
});

// Update a single fact
await client.facts.update(interactionId, factId, { text: "Temperature 39.0°C" });
// List available fact groups
const groups = await client.facts.factGroupsList();

const socket = await client.stream.connect({
    id: interactionId,
    configuration: {
        transcription: {
            primaryLanguage: "en",
            participants: [{ channel: 0, role: "doctor" }],
        },
        mode: { type: "facts", outputLocale: "en" },
    },
});

socket.on("message", (msg) => {
    console.log(msg.type, msg.data);
});

socket.sendAudio(audioBuffer);

const socket = await CortiWebSocketProxyClient.stream.connect({
    proxy: {
        url: "wss://your-proxy.com/corti/stream",
        protocols: ["custom-protocol"],
        queryParameters: { interactionId: "id" },
    },
    configuration: {
        transcription: {
            primaryLanguage: "en",
            participants: [{ channel: 0, role: "doctor" }],
        },
        mode: { type: "facts", outputLocale: "en" },
    },
    awaitConfiguration: true, // default: true
    debug: false,
    reconnectAttempts: 3,
});

socket.on("message", (msg) => console.log(msg.type, msg.data));
socket.sendAudio(audioBuffer);

const socket = await CortiWebSocketProxyClient.transcribe.connect({
    proxy: {
        url: "wss://your-proxy.com/corti/transcribe",
    },
    configuration: {
        primaryLanguage: "en",
        automaticPunctuation: true,
    },
});

socket.on("message", (msg) => {
    if (msg.type === "transcript") {
        console.log(msg.data.text);
    }
});
socket.sendAudio(audioBuffer);