Your IFC workspace,
connected to your tools.

// Node 22+: ONTOLOGIC_API_KEY must be set in the calling server environment.
// node --experimental-strip-types examples/api/quickstart.ts https://your-host.example sample.ifc
import { readFile, stat } from "node:fs/promises";
import { createHash, randomUUID } from "node:crypto";
import { basename, resolve } from "node:path";
import { pathToFileURL } from "node:url";

type Project = { id: string };
type Model = {
  id: string;
  original: { status: string };
  analysis: { status: string };
};
type Upload = {
  uploadId: string;
  modelId: string;
  upload: {
    url: string;
    method: string;
    headers: Record<string, string>;
  } | null;
};
export async function runQuickstart(
  base: string,
  key: string,
  filename: string,
  fetcher: typeof fetch = fetch,
) {
  // Validate before hashing or creating remote resources. Keep the local file unchanged during this run.
  const maxBytes = 150 * 1024 * 1024;
  const file = await stat(filename);
  if (!file.isFile() || file.size < 1 || file.size > maxBytes)
    throw new Error("Choose an IFC file between 1 byte and 150 MiB.");
  const original = await readFile(filename);
  if (original.length !== file.size)
    throw new Error(
      "The IFC file changed while reading; retry with a stable file.",
    );
  const checksum = createHash("sha256").update(original).digest("hex");
  const root = base.replace(/\/$/, "") + "/api/v1";
  async function api<T>(
    path: string,
    method = "GET",
    body?: unknown,
    operationId?: string,
  ): Promise<T> {
    const response = await fetcher(root + path, {
      method,
      headers: {
        Authorization: "Bearer " + key,
        ...(body === undefined ? {} : { "Content-Type": "application/json" }),
        ...(operationId ? { "Idempotency-Key": operationId } : {}),
      },
      ...(body === undefined ? {} : { body: JSON.stringify(body) }),
    });
    const json = await response.json();
    if (!response.ok)
      throw new Error(
        "API " +
          response.status +
          ": " +
          json.error.code +
          " (request " +
          json.error.requestId +
          ")",
      );
    return json.data as T;
  }
  await api("/whoami");
  // Persist these IDs if adding application-level retries. Reuse the same ID and payload on retry.
  const project = await api<Project>(
    "/projects",
    "POST",
    { name: "IFC integration", description: "API upload" },
    randomUUID(),
  );
  const session = await api<Upload>(
    "/projects/" + project.id + "/uploads",
    "POST",
    {
      filename: basename(filename),
      revision: "A",
      bytes: original.length,
      checksum,
    },
    randomUUID(),
  );
  if (session.upload) {
    const transfer = await fetcher(session.upload.url, {
      method: session.upload.method,
      headers: session.upload.headers,
      body: original,
    });
    if (!transfer.ok)
      throw new Error("Storage upload failed with HTTP " + transfer.status);
  }
  // A 409 verification_in_progress can be retried after Retry-After. Integrity failures need a new revision.
  const model = await api<Model>(
    "/projects/" + project.id + "/uploads/" + session.uploadId + "/complete",
    "POST",
    {},
  );
  await api("/projects/" + project.id + "/models");
  const details = await api<Model>(
    "/projects/" + project.id + "/models/" + model.id,
  );
  const download = await api<{ url: string; checksum: string }>(
    "/projects/" + project.id + "/models/" + model.id + "/download",
  );
  const response = await fetcher(download.url);
  if (!response.ok) throw new Error("Download failed");
  const returned = new Uint8Array(await response.arrayBuffer());
  if (
    createHash("sha256").update(returned).digest("hex") !== checksum ||
    download.checksum !== checksum
  )
    throw new Error("Downloaded original differs from the uploaded file.");
  return {
    projectId: project.id,
    modelId: model.id,
    original: details.original.status,
    analysis: details.analysis.status,
    checksum,
  };
}
if (
  process.argv[1] &&
  import.meta.url === pathToFileURL(resolve(process.argv[1])).href
) {
  const [base, filename] = process.argv.slice(2),
    key = process.env.ONTOLOGIC_API_KEY;
  if (!base || !filename || !key)
    throw new Error("Provide base URL, IFC filename and ONTOLOGIC_API_KEY.");
  console.log(await runQuickstart(base, key, filename));
}

# PowerShell 7+ and curl. Set ONTOLOGIC_API_KEY in your server environment.
param([Parameter(Mandatory=$true)][string]$BaseUrl,[Parameter(Mandatory=$true)][string]$IfcFile)
$ErrorActionPreference = 'Stop'
if (-not $env:ONTOLOGIC_API_KEY) { throw 'Set ONTOLOGIC_API_KEY first.' }
$apiExampleFile = (Resolve-Path -LiteralPath $IfcFile).Path
$apiExampleRoot = $BaseUrl.TrimEnd('/') + '/api/v1'
$apiExampleBytes = (Get-Item -LiteralPath $apiExampleFile).Length
if ($apiExampleBytes -lt 1 -or $apiExampleBytes -gt 157286400) { throw 'Choose an IFC file between 1 byte and 150 MiB.' }
# Keep the local file unchanged while hashing/transferring.
$apiExampleHash = (Get-FileHash -LiteralPath $apiExampleFile -Algorithm SHA256).Hash.ToLowerInvariant()
$apiExampleTemp = Join-Path ([System.IO.Path]::GetTempPath()) ('ontologic-api-' + [guid]::NewGuid())
New-Item -ItemType Directory -Path $apiExampleTemp | Out-Null
function Invoke-Ontologic([string]$Path,[string]$Method='GET',$Body=$null,[string]$Idempotency='') {
  $apiExampleArgs = @('--silent','--show-error','--fail-with-body','-X',$Method,'--header',('Authorization: Bearer ' + $env:ONTOLOGIC_API_KEY))
  if ($null -ne $Body) {
    $apiExampleJson = Join-Path $apiExampleTemp 'request.json'
    [System.IO.File]::WriteAllText($apiExampleJson,($Body | ConvertTo-Json -Compress))
    $apiExampleArgs += @('--header','Content-Type: application/json','--data-binary',('@' + $apiExampleJson))
  }
  if ($Idempotency) { $apiExampleArgs += @('--header',('Idempotency-Key: ' + $Idempotency)) }
  $apiExampleOutput = & curl.exe @apiExampleArgs ($apiExampleRoot + $Path)
  if ($LASTEXITCODE -ne 0) { throw ('API request failed: ' + $apiExampleOutput) }
  return ($apiExampleOutput | ConvertFrom-Json).data
}
try {
  $null = Invoke-Ontologic '/whoami'
  # Persist/reuse these IDs for retries of the same operation. Each script run creates a new project.
  $apiExampleProject = Invoke-Ontologic '/projects' 'POST' @{name='IFC integration';description='curl upload'} ([guid]::NewGuid().ToString())
  $apiExamplePath = '/projects/' + $apiExampleProject.id
  $apiExampleUpload = Invoke-Ontologic ($apiExamplePath + '/uploads') 'POST' @{
    filename=[System.IO.Path]::GetFileName($apiExampleFile);revision='A';bytes=$apiExampleBytes;checksum=$apiExampleHash
  } ([guid]::NewGuid().ToString())
  if ($apiExampleUpload.upload) {
    $null = & curl.exe --silent --show-error --fail-with-body -X PUT --header 'Content-Type: application/octet-stream' --data-binary ('@' + $apiExampleFile) $apiExampleUpload.upload.url
    if ($LASTEXITCODE -ne 0) { throw 'IFC transfer failed.' }
  }
  $apiExampleModel = Invoke-Ontologic ($apiExamplePath + '/uploads/' + $apiExampleUpload.uploadId + '/complete') 'POST' @{}
  $null = Invoke-Ontologic ($apiExamplePath + '/models')
  $apiExampleDetails = Invoke-Ontologic ($apiExamplePath + '/models/' + $apiExampleModel.id)
  $apiExampleDownload = Invoke-Ontologic ($apiExamplePath + '/models/' + $apiExampleModel.id + '/download')
  $apiExampleReturned = Join-Path $apiExampleTemp 'download.ifc'
  & curl.exe --silent --show-error --fail-with-body --output $apiExampleReturned $apiExampleDownload.url
  if ($LASTEXITCODE -ne 0) { throw 'IFC download failed.' }
  if ((Get-FileHash -LiteralPath $apiExampleReturned -Algorithm SHA256).Hash.ToLowerInvariant() -ne $apiExampleHash) { throw 'Original checksum mismatch.' }
  @{projectId=$apiExampleProject.id;modelId=$apiExampleModel.id;original=$apiExampleDetails.original.status;analysis=$apiExampleDetails.analysis.status;checksum=$apiExampleHash} | ConvertTo-Json
} finally {
  # Remove only the exact three temporary files this example created.
  foreach ($apiExampleName in @('request.json','download.ifc')) {
    $apiExampleTarget = Join-Path $apiExampleTemp $apiExampleName
    if (Test-Path -LiteralPath $apiExampleTarget) { Remove-Item -LiteralPath $apiExampleTarget }
  }
  Remove-Item -LiteralPath $apiExampleTemp
}