Platform administration

Response 200

{
  top: {
    hosts?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
    deployments?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
    paths?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
    orgs?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
    countries?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
    projects?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
  }
  unattributed: number
  updatedAt: null | number
  range: "24h" | "7d" | "30d" | "90d"
  step: number
  from: string
  to: string
  totals: {
    bytes: number
    requests: number
    s2xx: number
    s3xx: number
    s4xx: number
    s5xx: number
    hits: number
    misses: number
    p50: null | number
    p95: null | number
  }
  series: {
    bytes: number
    requests: number
    s2xx: number
    s3xx: number
    s4xx: number
    s5xx: number
    hits: number
    misses: number
    p50: null | number
    p95: null | number
    t: string
  }[]
}

Response 200

{
  days: number
  total: {
    sent: number
    received: number
    bounced: number
    complained: number
  }
  orgs: {
    orgId: string
    sent: number
    received: number
    bounced: number
    complained: number
  }[]
}

Response 200

{
  month: string
  currency: string
  estimated: boolean
  costError?: string
  orgs: {
    projects: number
    repositories: number
    databases: number
    buckets: number
    requests: null | number
    bytes: null | number
    mailSent: null | number
    mailReceived: null | number
    orgId: string
    name: string
    slug: string
    kind: "platform" | "customer"
    planId?: string
    cost: null | number
  }[]
  untagged: null | number
  otherOrgs: null | number
}

Response 201

{
  runId: string
}

Response 200

{
  run: null | {
    runId: string
    commit: null | string
    startedAt: number
  }
}

Response 200

{
  runs: {
    branch?: string
    source: "local" | "ci"
    startedAt: number
    commit?: string
    finishedAt: number
    totals: {
      lines: {
        total: number
        covered: number
      }
      branches: {
        total: number
        covered: number
      }
      functions: {
        total: number
        covered: number
      }
      tests: {
        total: number
        passed: number
        failed: number
        skipped: number
        todo: number
        cancelled: number
      }
      durationMs: number
      packages: number
      failedPackages: number
    }
    runUrl?: string
    runId: string
  }[]
  run: null | {
    branch?: string
    source: "local" | "ci"
    startedAt: number
    commit?: string
    finishedAt: number
    totals: {
      lines: {
        total: number
        covered: number
      }
      branches: {
        total: number
        covered: number
      }
      functions: {
        total: number
        covered: number
      }
      tests: {
        total: number
        passed: number
        failed: number
        skipped: number
        todo: number
        cancelled: number
      }
      durationMs: number
      packages: number
      failedPackages: number
    }
    runUrl?: string
    runId: string
  }
  packages: {
    error?: string
    name: string
    status: "error" | "failed" | "passed"
    durationMs: number
    dir: string
    files: {
      loaded: number
      source: number
    }
    lines: {
      total: number
      covered: number
    }
    tests: {
      total: number
      passed: number
      failed: number
      skipped: number
      todo: number
      cancelled: number
    }
    cached?: boolean
    branches: {
      total: number
      covered: number
    }
    functions: {
      total: number
      covered: number
    }
  }[]
  previous: null | {
    runId: string
    packages: {
      error?: string
      name: string
      status: "error" | "failed" | "passed"
      durationMs: number
      dir: string
      files: {
        loaded: number
        source: number
      }
      lines: {
        total: number
        covered: number
      }
      tests: {
        total: number
        passed: number
        failed: number
        skipped: number
        todo: number
        cancelled: number
      }
      cached?: boolean
      branches: {
        total: number
        covered: number
      }
      functions: {
        total: number
        covered: number
      }
    }[]
  }
}

Response 200

{
  package: {
    lines: {
      total: number
      covered: number
    }
    branches: {
      total: number
      covered: number
    }
    functions: {
      total: number
      covered: number
    }
    name: string
    dir: string
    status: "error" | "failed" | "passed"
    tests: {
      total: number
      passed: number
      failed: number
      skipped: number
      todo: number
      cancelled: number
    }
    durationMs: number
    files: {
      loaded: number
      source: number
    }
    leastCovered: {
      lines: {
        total: number
        covered: number
      }
      branches: {
        total: number
        covered: number
      }
      functions: {
        total: number
        covered: number
      }
      path: string
    }[]
    untested: string[]
    error?: string
    cached?: boolean
  }
}

Response 200

{
  stored: {
    postLength?: number
    mediaPerPost?: number
    imageBytes?: number
    videoBytes?: number
    editWindowMinutes?: number
    editsPerPost?: number
    postsPerHour?: number
    followsPerDay?: number
    maxFollowing?: number
    fanoutMaxFollowers?: number
    fanoutBatch?: number
    feedDays?: number
    storyHours?: number
    notificationDays?: number
    ranking?: {
      follows: number
      sharesServer: number
      affinity: number
      affinityCap: number
      engagement: number
      likedByFollowee: number
      popular: number
      notInterestedAuthor: number
      notInterestedTag: number
      halfLifeHours: number
    }
    blockedWords?: string[]
  }
  settings: {
    postLength: number
    mediaPerPost: number
    imageBytes: number
    videoBytes: number
    editWindowMinutes: number
    editsPerPost: number
    postsPerHour: number
    followsPerDay: number
    maxFollowing: number
    fanoutMaxFollowers: number
    fanoutBatch: number
    feedDays: number
    storyHours: number
    notificationDays: number
    ranking: {
      follows: number
      sharesServer: number
      affinity: number
      affinityCap: number
      engagement: number
      likedByFollowee: number
      popular: number
      notInterestedAuthor: number
      notInterestedTag: number
      halfLifeHours: number
    }
    blockedWords: string[]
  }
  defaults: {
    postLength: number
    mediaPerPost: number
    imageBytes: number
    videoBytes: number
    editWindowMinutes: number
    editsPerPost: number
    postsPerHour: number
    followsPerDay: number
    maxFollowing: number
    fanoutMaxFollowers: number
    fanoutBatch: number
    feedDays: number
    storyHours: number
    notificationDays: number
    ranking: {
      follows: number
      sharesServer: number
      affinity: number
      affinityCap: number
      engagement: number
      likedByFollowee: number
      popular: number
      notInterestedAuthor: number
      notInterestedTag: number
      halfLifeHours: number
    }
    blockedWords: string[]
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  stored: {
    postLength?: number
    mediaPerPost?: number
    imageBytes?: number
    videoBytes?: number
    editWindowMinutes?: number
    editsPerPost?: number
    postsPerHour?: number
    followsPerDay?: number
    maxFollowing?: number
    fanoutMaxFollowers?: number
    fanoutBatch?: number
    feedDays?: number
    storyHours?: number
    notificationDays?: number
    ranking?: {
      follows: number
      sharesServer: number
      affinity: number
      affinityCap: number
      engagement: number
      likedByFollowee: number
      popular: number
      notInterestedAuthor: number
      notInterestedTag: number
      halfLifeHours: number
    }
    blockedWords?: string[]
  }
  settings: {
    postLength: number
    mediaPerPost: number
    imageBytes: number
    videoBytes: number
    editWindowMinutes: number
    editsPerPost: number
    postsPerHour: number
    followsPerDay: number
    maxFollowing: number
    fanoutMaxFollowers: number
    fanoutBatch: number
    feedDays: number
    storyHours: number
    notificationDays: number
    ranking: {
      follows: number
      sharesServer: number
      affinity: number
      affinityCap: number
      engagement: number
      likedByFollowee: number
      popular: number
      notInterestedAuthor: number
      notInterestedTag: number
      halfLifeHours: number
    }
    blockedWords: string[]
  }
  defaults: {
    postLength: number
    mediaPerPost: number
    imageBytes: number
    videoBytes: number
    editWindowMinutes: number
    editsPerPost: number
    postsPerHour: number
    followsPerDay: number
    maxFollowing: number
    fanoutMaxFollowers: number
    fanoutBatch: number
    feedDays: number
    storyHours: number
    notificationDays: number
    ranking: {
      follows: number
      sharesServer: number
      affinity: number
      affinityCap: number
      engagement: number
      likedByFollowee: number
      popular: number
      notInterestedAuthor: number
      notInterestedTag: number
      halfLifeHours: number
    }
    blockedWords: string[]
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  ageAssurance: {
    outcome: "16_plus" | "under_16"
    adult?: boolean
    method: "document" | "dev" | "self_declared" | "estimation" | "digital_id" | "bank" | "inference" | "staff"
    provider: string
    reference?: string
    checkedAt: number
    recheckAfter?: number
  }
}

Response 204 with no body

Response 200

{
  circuits: {
    circuitId: string
    name: string
    region: string
    boundary: [number, number][]
    gate: [[number, number], [number, number]]
    lengthKm: number
    enabled: boolean
    verified: boolean
    notes: null | string
    updatedAt: null | number
  }[]
}

Response 200

{
  circuit: {
    circuitId: string
    name: string
    region: string
    boundary: [number, number][]
    gate: [[number, number], [number, number]]
    lengthKm: number
    enabled: boolean
    verified: boolean
  }
}

Response 204 with no body

Response 200

{
  factors: {
    iceGramsPerKm: number
    gridGramsPerKwh: number
    offPeak: {
      from: number
      to: number
    }
    solarHours: {
      from: number
      to: number
    }
    gentleLong: number
    gentleLat: number
    harshLong: number
    harshLat: number
  }
}

Response 200

{
  factors: {
    iceGramsPerKm: number
    gridGramsPerKwh: number
    offPeak: {
      from: number
      to: number
    }
    solarHours: {
      from: number
      to: number
    }
    gentleLong: number
    gentleLat: number
    harshLong: number
    harshLat: number
  }
}

Response 200

{
  settings: {
    provider: "off" | "klipy" | "giphy"
    rating: "r" | "g" | "pg" | "pg-13"
  }
  defaults: {
    provider: "off" | "klipy" | "giphy"
    rating: "r" | "g" | "pg" | "pg-13"
  }
  keys: {
    klipy: boolean
    giphy: boolean
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  settings: {
    provider: "off" | "klipy" | "giphy"
    rating: "r" | "g" | "pg" | "pg-13"
  }
  defaults: {
    provider: "off" | "klipy" | "giphy"
    rating: "r" | "g" | "pg" | "pg-13"
  }
  keys: {
    klipy: boolean
    giphy: boolean
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  stored: {
    mode?: "off" | "self_declared" | "estimation"
    estimation?: {
      region?: string
      minConfidence?: number
      passLowAtLeast?: number
      underHighBelow?: number
      retries?: number
      attemptsPerDay?: number
    }
  }
  settings: {
    mode: "off" | "self_declared" | "estimation"
    estimation: {
      region: string
      minConfidence: number
      passLowAtLeast: number
      underHighBelow: number
      retries: number
      attemptsPerDay: number
    }
  }
  defaults: {
    mode: "off" | "self_declared" | "estimation"
    estimation: {
      region: string
      minConfidence: number
      passLowAtLeast: number
      underHighBelow: number
      retries: number
      attemptsPerDay: number
    }
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  previousMode: "off" | "self_declared" | "estimation"
  stored: {
    mode?: "off" | "self_declared" | "estimation"
    estimation?: {
      region?: string
      minConfidence?: number
      passLowAtLeast?: number
      underHighBelow?: number
      retries?: number
      attemptsPerDay?: number
    }
  }
  settings: {
    mode: "off" | "self_declared" | "estimation"
    estimation: {
      region: string
      minConfidence: number
      passLowAtLeast: number
      underHighBelow: number
      retries: number
      attemptsPerDay: number
    }
  }
  defaults: {
    mode: "off" | "self_declared" | "estimation"
    estimation: {
      region: string
      minConfidence: number
      passLowAtLeast: number
      underHighBelow: number
      retries: number
      attemptsPerDay: number
    }
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  account: {
    userId: string
    email: string
    name: null | string
    createdAt?: number
  }
  age: {
    birthDate: null | string
    birthDateSource: null | "staff" | "self"
    age: null | {
      outcome: "16_plus" | "under_16"
      adult?: boolean
      method: "document" | "dev" | "self_declared" | "estimation" | "digital_id" | "bank" | "inference" | "staff"
      provider: string
      reference?: string
      checkedAt: number
      recheckAfter?: number
    }
    gate: {
      open: true
      method: "none" | "document" | "dev" | "self_declared" | "estimation" | "digital_id" | "bank" | "inference" | "staff"
      checkedAt: number
    } | {
      open: false
      reason: "under_16" | "unchecked"
      recheckAfter: null | number
      check?: "estimation" | "date_of_birth"
    }
    mode: "off" | "self_declared" | "estimation"
    estimation: {
      available: boolean
      standIn: boolean
      attemptsLeft: number
      inconclusive: number
      retries: number
    }
  }
}

Response 200

{
  age: {
    birthDate: null | string
    birthDateSource: null | "staff" | "self"
    age: null | {
      outcome: "16_plus" | "under_16"
      adult?: boolean
      method: "document" | "dev" | "self_declared" | "estimation" | "digital_id" | "bank" | "inference" | "staff"
      provider: string
      reference?: string
      checkedAt: number
      recheckAfter?: number
    }
    gate: {
      open: true
      method: "none" | "document" | "dev" | "self_declared" | "estimation" | "digital_id" | "bank" | "inference" | "staff"
      checkedAt: number
    } | {
      open: false
      reason: "under_16" | "unchecked"
      recheckAfter: null | number
      check?: "estimation" | "date_of_birth"
    }
    mode: "off" | "self_declared" | "estimation"
    estimation: {
      available: boolean
      standIn: boolean
      attemptsLeft: number
      inconclusive: number
      retries: number
    }
  }
}

Response 200

{
  age: {
    birthDate: null | string
    birthDateSource: null | "staff" | "self"
    age: null | {
      outcome: "16_plus" | "under_16"
      adult?: boolean
      method: "document" | "dev" | "self_declared" | "estimation" | "digital_id" | "bank" | "inference" | "staff"
      provider: string
      reference?: string
      checkedAt: number
      recheckAfter?: number
    }
    gate: {
      open: true
      method: "none" | "document" | "dev" | "self_declared" | "estimation" | "digital_id" | "bank" | "inference" | "staff"
      checkedAt: number
    } | {
      open: false
      reason: "under_16" | "unchecked"
      recheckAfter: null | number
      check?: "estimation" | "date_of_birth"
    }
    mode: "off" | "self_declared" | "estimation"
    estimation: {
      available: boolean
      standIn: boolean
      attemptsLeft: number
      inconclusive: number
      retries: number
    }
  }
}

Response 200

{
  search: {
    settings: {
      provider: "exa" | "brave" | "mock"
      prices?: {
        exa?: {
          links: number
          text: number
        }
        brave?: {
          links: number
          text: number
        }
        mock?: {
          links: number
          text: number
        }
      }
    }
    defaultPrices: {
      exa: {
        links: number
        text: number
      }
      brave: {
        links: number
        text: number
      }
      mock: {
        links: number
        text: number
      }
    }
    keys: {
      exa: boolean
      brave: boolean
    }
    updatedAt: null | number
    updatedBy: null | string
  }
  voice: {
    bridge: boolean
    settings: {
      sonic: boolean
    }
    updatedAt: null | number
    updatedBy: null | string
  }
  images: {
    on: boolean
    models: {
      id: string
      name: string
      madeIn: string
      ops: ("generate" | "inpaint" | "outpaint" | "remove-background" | "restyle")[]
      pricePerImage: number
      enabled: boolean
    }[]
    updatedAt: null | number
  }
  codeCloud: {
    settings: {
      on: boolean
      registries: string[]
      agent: {
        "linux-arm64"?: {
          version: string
          sha256: string
        }
        "linux-x64"?: {
          version: string
          sha256: string
        }
      }
      minuteUsd: number
    }
    updatedAt: null | number
    updatedBy: null | string
  }
}

Response 200

{
  search: {
    settings: {
      provider: "exa" | "brave" | "mock"
      prices?: {
        exa?: {
          links: number
          text: number
        }
        brave?: {
          links: number
          text: number
        }
        mock?: {
          links: number
          text: number
        }
      }
    }
    defaultPrices: {
      exa: {
        links: number
        text: number
      }
      brave: {
        links: number
        text: number
      }
      mock: {
        links: number
        text: number
      }
    }
    keys: {
      exa: boolean
      brave: boolean
    }
    updatedAt: null | number
    updatedBy: null | string
  }
}

Response 200

{
  voice: {
    bridge: boolean
    settings: {
      sonic: boolean
    }
    updatedAt: null | number
    updatedBy: null | string
  }
}

Response 200

{
  images: {
    on: boolean
    models: {
      id: string
      name: string
      madeIn: string
      ops: ("generate" | "inpaint" | "outpaint" | "remove-background" | "restyle")[]
      pricePerImage: number
      enabled: boolean
    }[]
    updatedAt: null | number
  }
}

Response 200

{
  codeCloud: {
    settings: {
      on: boolean
      registries: string[]
      agent: {
        "linux-arm64"?: {
          version: string
          sha256: string
        }
        "linux-x64"?: {
          version: string
          sha256: string
        }
      }
      minuteUsd: number
    }
    updatedAt: null | number
    updatedBy: null | string
  }
}

Response 200

{
  metrics: {
    metricId: string
    label: string
    category: "other" | "body" | "heart" | "cycle" | "activity" | "hearing" | "medications" | "mental" | "mindfulness" | "mobility" | "nutrition" | "respiratory" | "sleep" | "symptoms" | "vitals" | "sexual"
    kind: "duration" | "event" | "category" | "quantity"
    unit: string
    units: {
      id: string
      label: string
      factor: number
      offset?: number
    }[]
    aggregation: "duration" | "count" | "latest" | "sum" | "average"
    decimals: number
    sensitivity: "standard" | "sensitive" | "sexual"
    values?: {
      value: number
      label: string
    }[]
    healthKit?: {
      identifier: string
      kind: "category" | "quantity" | "workout"
      unit?: string
      readOnly?: boolean
      factor?: number
      categoryValues?: number[]
    }
    healthConnect?: string
    leaderboard?: "count" | "sum" | "average"
    min?: number
    max?: number
    pinned?: boolean
    description?: string
    enabled: boolean
    sortOrder: number
  }[]
}

Response 200

{
  metric: {
    metricId: string
    label: string
    category: "other" | "body" | "heart" | "cycle" | "activity" | "hearing" | "medications" | "mental" | "mindfulness" | "mobility" | "nutrition" | "respiratory" | "sleep" | "symptoms" | "vitals" | "sexual"
    kind: "duration" | "event" | "category" | "quantity"
    unit: string
    units: {
      id: string
      label: string
      factor: number
      offset?: number
    }[]
    aggregation: "duration" | "count" | "latest" | "sum" | "average"
    decimals: number
    sensitivity: "standard" | "sensitive" | "sexual"
    values?: {
      value: number
      label: string
    }[]
    healthKit?: {
      identifier: string
      kind: "category" | "quantity" | "workout"
      unit?: string
      readOnly?: boolean
      factor?: number
      categoryValues?: number[]
    }
    healthConnect?: string
    leaderboard?: "count" | "sum" | "average"
    min?: number
    max?: number
    pinned?: boolean
    description?: string
    enabled: boolean
    sortOrder: number
  }
}

Response 200

{
  metric: {
    enabled: boolean
    metricId: string
    label: string
    category: "other" | "body" | "heart" | "cycle" | "activity" | "hearing" | "medications" | "mental" | "mindfulness" | "mobility" | "nutrition" | "respiratory" | "sleep" | "symptoms" | "vitals" | "sexual"
    kind: "duration" | "event" | "category" | "quantity"
    unit: string
    units: {
      id: string
      label: string
      factor: number
      offset?: number
    }[]
    aggregation: "duration" | "count" | "latest" | "sum" | "average"
    decimals: number
    sensitivity: "standard" | "sensitive" | "sexual"
    values?: {
      value: number
      label: string
    }[]
    healthKit?: {
      identifier: string
      kind: "category" | "quantity" | "workout"
      unit?: string
      readOnly?: boolean
      factor?: number
      categoryValues?: number[]
    }
    healthConnect?: string
    leaderboard?: "count" | "sum" | "average"
    min?: number
    max?: number
    pinned?: boolean
    description?: string
    sortOrder: number
  }
}

Response 200

{
  added: string[]
}

Response 200

{
  settings: {
    samplesPerRequest: number
    auditDays: number
    sexualLeaderboardServers: string[]
  }
  defaults: {
    samplesPerRequest: number
    auditDays: number
    sexualLeaderboardServers: string[]
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  settings: {
    samplesPerRequest: number
    auditDays: number
    sexualLeaderboardServers: string[]
  }
  defaults: {
    samplesPerRequest: number
    auditDays: number
    sexualLeaderboardServers: string[]
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  servers: {
    serverId: string
    name: null | string
  }[]
}

Response 200

{
  stores: {
    name: string
    pdf: "off" | "model" | "rules"
    enabled: boolean
    sortOrder: number
    senderDomains: string[]
    receiptMarks: string[]
    endMarks: string[]
    skipMarks: string[]
    brandPrefixes: string[]
    storeId: string
    updatedAt?: number
  }[]
  nonFoodWords: string[]
  seed: {
    stores: boolean
    nonFoodWords: boolean
  }
}

Response 200

{
  store: {
    name: string
    createdAt?: number
    updatedAt?: number
    pdf?: "off" | "model" | "rules"
    enabled?: boolean
    sortOrder?: number
    storeId: string
    senderDomains: string[]
    receiptMarks: string[]
    endMarks: string[]
    skipMarks: string[]
    brandPrefixes: string[]
  }
}

Response 200

{
  ok: true
}

Response 201

{
  word: string
}

Response 200

{
  ok: true
}

Response 200

{
  result: {
    lines: {
      ingredientId?: string
      food: boolean
      unit?: "slice" | "head" | "g" | "kg" | "mg" | "oz" | "lb" | "ml" | "l" | "tsp" | "tbsp" | "cup" | "floz" | "pint" | "quart" | "pinch" | "dash" | "piece" | "clove" | "can" | "jar" | "bunch" | "handful" | "sprig" | "sheet" | "packet" | "stick" | "fillet" | "rasher" | "leaf" | "stalk"
      quantity?: number
      text: string
      name: string
      price?: number
    }[]
    total?: number
    purchasedOn?: string
    model: "text" | "pdf"
    pdf?: {
      read: true
      pages: number
      text: string
      truncated: boolean
    } | {
      read: false
      problem: "not-pdf" | "too-large" | "encrypted" | "too-complex" | "unreadable" | "no-text"
      message: string
    } | {
      read: false
      skipped: "off" | "model"
    }
    marked: boolean
    isReceipt: boolean
    source: "message" | "pdf"
    store?: {
      id: string
      name: string
    }
  }
}

Response 200

{
  effects: {
    effectId: string
    name: string
    renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
    colors: string[]
    enabled: boolean
    sortOrder: number
  }[]
}

Response 200

{
  effect: {
    effectId: string
    name: string
    renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
    colors: string[]
    enabled: boolean
    sortOrder: number
  }
}

Response 200

{
  effect: {
    effectId: string
    name: string
    renderer: "sparkles" | "snow" | "hearts" | "glow" | "aurora" | "confetti"
    colors: string[]
    enabled: boolean
    sortOrder: number
  }
}

Response 200

{
  added: string[]
}

Response 200

{
  locales: {
    locale: string
    label: string
    spelling: "au" | "us"
    weekStart: number
    enabled: boolean
    sortOrder: number
  }[]
  stored: boolean
  defaults: {
    locale: string
    label: string
    spelling: "au" | "us"
    weekStart: number
    enabled: boolean
    sortOrder: number
  }[]
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  locales: {
    locale: string
    label: string
    spelling: "au" | "us"
    weekStart: number
    enabled: boolean
    sortOrder: number
  }[]
  stored: boolean
  defaults: {
    locale: string
    label: string
    spelling: "au" | "us"
    weekStart: number
    enabled: boolean
    sortOrder: number
  }[]
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  settings: {
    tiers: {
      tierId: string
      name: string
      months: number
      art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
      form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
    }[]
    earlySupporterCutoff: string
    gapDays: number
  }
  defaults: {
    tiers: {
      tierId: string
      name: string
      months: number
      art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
      form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
    }[]
    earlySupporterCutoff: string
    gapDays: number
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  settings: {
    tiers: {
      tierId: string
      name: string
      months: number
      art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
      form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
    }[]
    earlySupporterCutoff: string
    gapDays: number
  }
  defaults: {
    tiers: {
      tierId: string
      name: string
      months: number
      art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
      form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
    }[]
    earlySupporterCutoff: string
    gapDays: number
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  person: {
    userId: string
    name: null | string
    email: string
    badges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    hidden: boolean
    grant: null | {
      state: "revoked" | "granted"
      by: string
      at: number
    }
    accounts: {
      ownerId: string
      ownerType: "user" | "org"
      status: "active" | "none" | "canceled" | "incomplete" | "trialing" | "past_due" | "unpaid"
      subscribedAt?: number
      firstPaidAt?: number
      paidSince?: number
      lapsedAt?: number
    }[]
  }
}

Response 200

{
  person: {
    userId: string
    name: null | string
    email: string
    badges: {
      kind: "early-supporter"
      since: null | number
    } | {
      kind: "subscriber"
      since: number
      tier: {
        form: "stone" | "cut" | "brilliant" | "radiant" | "spark"
        name: string
        months: number
        art: "quartz" | "bronze" | "silver" | "gold" | "platinum" | "diamond" | "emerald" | "ruby" | "opal" | "early"
        id: string
      }
    }[]
    hidden: boolean
    grant: null | {
      state: "revoked" | "granted"
      by: string
      at: number
    }
    accounts: {
      ownerId: string
      ownerType: "user" | "org"
      status: "active" | "none" | "canceled" | "incomplete" | "trialing" | "past_due" | "unpaid"
      subscribedAt?: number
      firstPaidAt?: number
      paidSince?: number
      lapsedAt?: number
    }[]
  }
}

Response 200

{
  people: {
    userId: string
    name: null | string
    email: string
    plan: {
      planId?: string
      via: "subsidised" | "subscription" | "free"
      planName?: string
    }
    subsidy: null | {
      planId: string
      planName?: string
      by: string
      byLabel?: string
      at: number
      until?: number
      note?: string
      active: boolean
    }
    subscription: null | {
      planId?: string
      planName?: string
      status: "active" | "none" | "canceled" | "incomplete" | "trialing" | "past_due" | "unpaid"
      interval?: "month" | "two-year" | "year"
    }
  }[]
}

Response 200

{
  person: {
    userId: string
    name: null | string
    email: string
    plan: {
      planId?: string
      via: "subsidised" | "subscription" | "free"
      planName?: string
    }
    subsidy: null | {
      planId: string
      planName?: string
      by: string
      byLabel?: string
      at: number
      until?: number
      note?: string
      active: boolean
    }
    subscription: null | {
      planId?: string
      planName?: string
      status: "active" | "none" | "canceled" | "incomplete" | "trialing" | "past_due" | "unpaid"
      interval?: "month" | "two-year" | "year"
    }
  }
}

Response 200

{
  person: {
    userId: string
    name: null | string
    email: string
    plan: {
      planId?: string
      via: "subsidised" | "subscription" | "free"
      planName?: string
    }
    subsidy: null | {
      planId: string
      planName?: string
      by: string
      byLabel?: string
      at: number
      until?: number
      note?: string
      active: boolean
    }
    subscription: null | {
      planId?: string
      planName?: string
      status: "active" | "none" | "canceled" | "incomplete" | "trialing" | "past_due" | "unpaid"
      interval?: "month" | "two-year" | "year"
    }
  }
}

Response 200

{
  person: {
    userId: string
    name: null | string
    email: string
    plan: {
      planId?: string
      via: "subsidised" | "subscription" | "free"
      planName?: string
    }
    subsidy: null | {
      planId: string
      planName?: string
      by: string
      byLabel?: string
      at: number
      until?: number
      note?: string
      active: boolean
    }
    subscription: null | {
      planId?: string
      planName?: string
      status: "active" | "none" | "canceled" | "incomplete" | "trialing" | "past_due" | "unpaid"
      interval?: "month" | "two-year" | "year"
    }
  }
}

Response 200

{
  reports: {
    reporter?: {
      userId: string
      name: string
    }
    serverName?: null | string
    reportId: string
    kind: "post" | "message" | "user" | "server" | "dm_message" | "story"
    status: "open" | "dismissed" | "actioned"
    reason: string
    reasonLabel: string
    details: null | string
    target: {
      userId: string
      name: string
    }
    serverId: null | string
    channelId: null | string
    messageId: null | string
    dmId: null | string
    snapshot: unknown
    resolvedBy: null | {
      userId: string
      name: string
    }
    resolvedAt: null | number
    note: null | string
    createdAt: number
  }[]
  next: null | string
}

Response 200

{
  report: {
    reporter?: {
      userId: string
      name: string
    }
    serverName?: null | string
    reportId: string
    kind: "post" | "message" | "user" | "server" | "dm_message" | "story"
    status: "open" | "dismissed" | "actioned"
    reason: string
    reasonLabel: string
    details: null | string
    target: {
      userId: string
      name: string
    }
    serverId: null | string
    channelId: null | string
    messageId: null | string
    dmId: null | string
    snapshot: unknown
    resolvedBy: null | {
      userId: string
      name: string
    }
    resolvedAt: null | number
    note: null | string
    createdAt: number
  }
}

Response 200

{
  runners: {
    label: string
    description: string
    project: "lambda" | "container"
    environmentType: string
    computeType: string
    image: string
    multiplier: number
    maxMinutes: number
    docker: boolean
    orgs: string[]
    isDefault: boolean
    enabled: boolean
    sortOrder: number
  }[]
}

Response 200

{
  runner: {
    label: string
    createdAt?: number
    updatedAt?: number
    project: "lambda" | "container"
    description?: string
    image: string
    enabled?: boolean
    orgs?: string[]
    isDefault?: boolean
    sortOrder?: number
    environmentType: string
    computeType: string
    multiplier?: number
    maxMinutes: number
    docker?: boolean
  }
}

Response 204 with no body

Response 200

{
  settings: {
    maxMatrixJobs: number
    maxJobs: number
    maxLogMb: number
    maxArtifactMb: number
    maxCacheMb: number
    maxWorkflowKb: number
    scheduleMinMinutes: number
    approvalDays: number
    queueHours: number
    heartbeatMinutes: number
    defaultArtifactDays: number
    cacheUnusedDays: number
    secretKb: number
    maxSecrets: number
  }
  defaults: {
    maxMatrixJobs: number
    maxJobs: number
    maxLogMb: number
    maxArtifactMb: number
    maxCacheMb: number
    maxWorkflowKb: number
    scheduleMinMinutes: number
    approvalDays: number
    queueHours: number
    heartbeatMinutes: number
    defaultArtifactDays: number
    cacheUnusedDays: number
    secretKb: number
    maxSecrets: number
  }
}

Response 200

{
  settings: {
    maxMatrixJobs: number
    maxJobs: number
    maxLogMb: number
    maxArtifactMb: number
    maxCacheMb: number
    maxWorkflowKb: number
    scheduleMinMinutes: number
    approvalDays: number
    queueHours: number
    heartbeatMinutes: number
    defaultArtifactDays: number
    cacheUnusedDays: number
    secretKb: number
    maxSecrets: number
  }
}

Response 200

{
  reports: {
    reportId: string
    type: "suggestion" | "bug" | "feedback"
    typeLabel: string
    status: "pending" | "resolved" | "dismissed" | "spam" | "new" | "triaged"
    severity: null | "low" | "medium" | "high" | "critical"
    title: string
    description: string
    app: string
    appLabel: string
    reporter: {
      userId: string
      name: null | string
      email: null | string
    }
    contactOk: boolean
    orgId: null | string
    context: {
      app?: string
      appName?: string
      version?: string
      build?: string
      path?: string
      orgId?: string
      browser?: string
      os?: string
      device?: string
      viewport?: {
        width: number
        height: number
        scale?: number
      }
      locale?: string
      timeZone?: string
      shell?: string
      errors?: {
        message: string
        at: number
        source?: string
      }[]
      requests?: {
        method: string
        url: string
        status: number
        at: number
      }[]
      routes?: {
        path: string
        at: number
      }[]
    }
    images: {
      imageId: string
      type: "image/png" | "image/jpeg" | "image/webp"
      size: number
    }[]
    fingerprint: string
    similar: {
      count: number
      reportIds: string[]
    }
    spamReason: null | string
    commentCount: number
    issue: null | {
      orgId: string
      issueId: string
      key: string
      spaceKey: string
    }
    updatedBy: null | string
    createdAt: number
    submittedAt: number
    updatedAt?: number
  }[]
  next: null | string
  counts: {
    resolved: number
    dismissed: number
    spam: number
    new: number
    triaged: number
  }
  apps: {
    app: string
    label: string
  }[]
}

Response 200

{
  report: {
    images: {
      url: null | string
      imageId: string
      type: "image/png" | "image/jpeg" | "image/webp"
      size: number
    }[]
    reportId: string
    type: "suggestion" | "bug" | "feedback"
    typeLabel: string
    status: "pending" | "resolved" | "dismissed" | "spam" | "new" | "triaged"
    severity: null | "low" | "medium" | "high" | "critical"
    title: string
    description: string
    app: string
    appLabel: string
    reporter: {
      userId: string
      name: null | string
      email: null | string
    }
    contactOk: boolean
    orgId: null | string
    context: {
      app?: string
      appName?: string
      version?: string
      build?: string
      path?: string
      orgId?: string
      browser?: string
      os?: string
      device?: string
      viewport?: {
        width: number
        height: number
        scale?: number
      }
      locale?: string
      timeZone?: string
      shell?: string
      errors?: {
        message: string
        at: number
        source?: string
      }[]
      requests?: {
        method: string
        url: string
        status: number
        at: number
      }[]
      routes?: {
        path: string
        at: number
      }[]
    }
    fingerprint: string
    similar: {
      count: number
      reportIds: string[]
    }
    spamReason: null | string
    commentCount: number
    issue: null | {
      orgId: string
      issueId: string
      key: string
      spaceKey: string
    }
    updatedBy: null | string
    createdAt: number
    submittedAt: number
    updatedAt?: number
  }
  comments: {
    commentId: string
    author: {
      userId: string
      name: null | string
    }
    body: string
    createdAt?: number
  }[]
  similar: {
    reportId: string
    title: string
    type: "suggestion" | "bug" | "feedback"
    status: "pending" | "resolved" | "dismissed" | "spam" | "new" | "triaged"
    appLabel: string
    createdAt?: number
  }[]
}

Response 200

{
  report: {
    reportId: string
    type: "suggestion" | "bug" | "feedback"
    typeLabel: string
    status: "pending" | "resolved" | "dismissed" | "spam" | "new" | "triaged"
    severity: null | "low" | "medium" | "high" | "critical"
    title: string
    description: string
    app: string
    appLabel: string
    reporter: {
      userId: string
      name: null | string
      email: null | string
    }
    contactOk: boolean
    orgId: null | string
    context: {
      app?: string
      appName?: string
      version?: string
      build?: string
      path?: string
      orgId?: string
      browser?: string
      os?: string
      device?: string
      viewport?: {
        width: number
        height: number
        scale?: number
      }
      locale?: string
      timeZone?: string
      shell?: string
      errors?: {
        message: string
        at: number
        source?: string
      }[]
      requests?: {
        method: string
        url: string
        status: number
        at: number
      }[]
      routes?: {
        path: string
        at: number
      }[]
    }
    images: {
      imageId: string
      type: "image/png" | "image/jpeg" | "image/webp"
      size: number
    }[]
    fingerprint: string
    similar: {
      count: number
      reportIds: string[]
    }
    spamReason: null | string
    commentCount: number
    issue: null | {
      orgId: string
      issueId: string
      key: string
      spaceKey: string
    }
    updatedBy: null | string
    createdAt: number
    submittedAt: number
    updatedAt?: number
  }
}

Response 201

{
  comment: {
    commentId: string
    author: {
      userId: string
      name: null | string
    }
    body: string
    createdAt: number
  }
}

Response 200

{
  issue: {
    orgId: string
    issueId: string
    key: string
    spaceKey: string
  }
  report: {
    reportId: string
    type: "suggestion" | "bug" | "feedback"
    typeLabel: string
    status: "pending" | "resolved" | "dismissed" | "spam" | "new" | "triaged"
    severity: null | "low" | "medium" | "high" | "critical"
    title: string
    description: string
    app: string
    appLabel: string
    reporter: {
      userId: string
      name: null | string
      email: null | string
    }
    contactOk: boolean
    orgId: null | string
    context: {
      app?: string
      appName?: string
      version?: string
      build?: string
      path?: string
      orgId?: string
      browser?: string
      os?: string
      device?: string
      viewport?: {
        width: number
        height: number
        scale?: number
      }
      locale?: string
      timeZone?: string
      shell?: string
      errors?: {
        message: string
        at: number
        source?: string
      }[]
      requests?: {
        method: string
        url: string
        status: number
        at: number
      }[]
      routes?: {
        path: string
        at: number
      }[]
    }
    images: {
      imageId: string
      type: "image/png" | "image/jpeg" | "image/webp"
      size: number
    }[]
    fingerprint: string
    similar: {
      count: number
      reportIds: string[]
    }
    spamReason: null | string
    commentCount: number
    issue: null | {
      orgId: string
      issueId: string
      key: string
      spaceKey: string
    }
    updatedBy: null | string
    createdAt: number
    submittedAt: number
    updatedAt?: number
  }
}

Response 200

{
  reportId: string
}

Response 200

{
  deletions: {
    delId: string
    status: "blocked" | "cancelled" | "scheduled" | "erasing" | "finalising" | "erased"
    email?: string
    requestedAt: number
    eraseAt: number
    graceDays: number
    graceReason?: string
    client: string
    app?: string
    reason?: string
    cancelledAt?: number
    cancelledBy?: string
    plannedAt?: number
    planCounts?: {
      [key: string]: {
        [key: string]: number
      }
    }
    tasks: {
      total: number
      done: number
      failed: string[]
    }
    held?: boolean
  }[]
  launched: true
}

Response 200

{
  taskList: {
    updatedAt: number
    error?: string
    phase: "plan" | "erase" | "finalise"
    service: string
    status: "pending" | "done" | "failed" | "running"
    attempts: number
    counts: unknown
  }[]
  delId: string
  status: "blocked" | "cancelled" | "scheduled" | "erasing" | "finalising" | "erased"
  email?: string
  requestedAt: number
  eraseAt: number
  graceDays: number
  graceReason?: string
  client: string
  app?: string
  reason?: string
  cancelledAt?: number
  cancelledBy?: string
  plannedAt?: number
  planCounts?: {
    [key: string]: {
      [key: string]: number
    }
  }
  tasks: {
    total: number
    done: number
    failed: string[]
  }
  held?: boolean
}

Response 200

{
  orgs: {
    name: string
    createdAt?: number
    updatedAt?: number
    orgId: string
    slug: string
    kind: "platform" | "customer"
    planId?: string
    subsidised?: boolean
    billingRequired?: boolean
    pending?: boolean
    auditExportBucketId?: string
    logoUri?: string
    contactEmail?: string
    authStrength?: "any" | "mfa" | "passkey"
    authMethods?: string[]
    authGraceUntil?: number
    sessionHours?: number
    externalSharing?: "off" | "accounts" | "links"
    allowedDomains?: string[]
    linkMaxDays?: number
    assistantEnabled?: boolean
    assistantMaxMode?: "ask" | "reads" | "app" | "auto"
    assistantApps?: string[]
    assistantPublicShares?: boolean
    hiddenApps?: string[]
    formerSlugs?: string[]
    slugChangedAt?: number
    hostSlug?: string
  }[]
}

Response 201

{
  org: {
    name: string
    createdAt?: number
    updatedAt?: number
    orgId: string
    slug: string
    kind: "platform" | "customer"
    planId?: string
    subsidised?: boolean
    billingRequired?: boolean
    pending?: boolean
    auditExportBucketId?: string
    logoUri?: string
    contactEmail?: string
    authStrength?: "any" | "mfa" | "passkey"
    authMethods?: string[]
    authGraceUntil?: number
    sessionHours?: number
    externalSharing?: "off" | "accounts" | "links"
    allowedDomains?: string[]
    linkMaxDays?: number
    assistantEnabled?: boolean
    assistantMaxMode?: "ask" | "reads" | "app" | "auto"
    assistantApps?: string[]
    assistantPublicShares?: boolean
    hiddenApps?: string[]
    formerSlugs?: string[]
    slugChangedAt?: number
    hostSlug?: string
  }
  invite: {
    inviteId: string
    email: string
    link: string
    delivered: boolean
    expiresAt: number
  }
}

Response 200

{
  org: {
    name: string
    createdAt?: number
    updatedAt?: number
    orgId: string
    slug: string
    kind: "platform" | "customer"
    planId?: string
    subsidised?: boolean
    billingRequired?: boolean
    pending?: boolean
    auditExportBucketId?: string
    logoUri?: string
    contactEmail?: string
    authStrength?: "any" | "mfa" | "passkey"
    authMethods?: string[]
    authGraceUntil?: number
    sessionHours?: number
    externalSharing?: "off" | "accounts" | "links"
    allowedDomains?: string[]
    linkMaxDays?: number
    assistantEnabled?: boolean
    assistantMaxMode?: "ask" | "reads" | "app" | "auto"
    assistantApps?: string[]
    assistantPublicShares?: boolean
    hiddenApps?: string[]
    formerSlugs?: string[]
    slugChangedAt?: number
    hostSlug?: string
  }
}

Response 200

{
  orgs: number
  customers: number
  regions: number
  locations: number
}

Response 200

{
  events: {
    eventId: string
    orgId: string
    action: string
    actor: {
      type: "user" | "key" | "device" | "system"
      id: string
      label?: string
    }
    target: {
      type: string
      id: string
      label?: string
    }
    metadata?: {
      [key: string]: unknown
    }
    ip?: string
    userAgent?: string
    createdAt: number
  }[]
  cursor: null | string
  retentionDays?: number
}

Response 200

{
  clients: {
    connections: number
    createdAt?: number
    lastUsedAt?: number
    expiresAt?: number
    logoUri?: string
    clientUri?: string
    clientId: string
    name: string
    redirectUris: string[]
  }[]
}

Response 204 with no body

Response 200

{
  regions: {
    name: string
    status?: "active" | "disabled"
    createdAt?: number
    updatedAt?: number
    unavailable?: string[]
    regionId: string
  }[]
  locations: {
    label: string
    status?: "active" | "disabled" | "preview"
    createdAt?: number
    updatedAt?: number
    locationId: string
    isDefault?: boolean
    regions: string[]
    sortOrder?: number
  }[]
}

Response 200

{
  region: {
    name: string
    status?: "active" | "disabled"
    createdAt?: number
    updatedAt?: number
    unavailable?: string[]
    regionId: string
  }
}

Response 200

{
  location: {
    label: string
    status?: "active" | "disabled" | "preview"
    createdAt?: number
    updatedAt?: number
    locationId: string
    isDefault?: boolean
    regions: string[]
    sortOrder?: number
  }
}

Response 200

{
  funnel: {
    day: string
    started: number
    paid: number
    named: number
    complete: number
  }[]
  pending: {
    signupId: string
    audience: "personal" | "business"
    planId: string
    email?: string
    orgName?: string
    orgId?: string
    next: "invite" | "done" | "account" | "pay" | "details" | "secure"
    paidAt?: number
    createdAt: number
    remindersSent: number
  }[]
}

Response 200

{
  discounted: {
    ownerId: string
    ownerType: "user" | "org"
    ownerName?: string
    planId?: string
    interval?: "month" | "two-year" | "year"
    status: string
    subscriptionId?: string
    discount: {
      percentOff?: number
      amountOff?: number
      currency?: string
      duration: "once" | "repeating" | "forever"
      durationInMonths?: number
      code?: string
      name?: string
      startsAt?: number
      endsAt?: number
    }
  }[]
  creators: {
    roles: ("owner" | "admin" | "developer" | "viewer")[]
    emails: string[]
  }
  canCreate: boolean
  mode: "local" | "live" | "test"
  codes: {
    promotionCodeId: string
    code: string
    active: boolean
    couponId: string
    name?: string
    discount: {
      percentOff?: number
      amountOff?: number
      currency?: string
      duration: "once" | "repeating" | "forever"
      durationInMonths?: number
    }
    usable: boolean
    timesRedeemed: number
    maxRedemptions?: number
    expiresAt?: number
    firstTimeOnly: boolean
    minimumAmount?: number
    planIds?: string[]
    intervals?: ("month" | "two-year" | "year")[]
    email?: string
    ownerId?: string
    customerId?: string
    createdAt: number
    createdBy?: string
  }[]
  coupons: {
    createdAt: number
    planIds?: string[]
    discount: {
      percentOff?: number
      amountOff?: number
      currency?: string
      duration: "once" | "repeating" | "forever"
      durationInMonths?: number
    }
    valid: boolean
    timesRedeemed: number
    name?: string
    couponId: string
  }[]
}

Response 201

{
  code: {
    promotionCodeId: string
    code: string
    active: boolean
    couponId: string
    name?: string
    discount: {
      percentOff?: number
      amountOff?: number
      currency?: string
      duration: "once" | "repeating" | "forever"
      durationInMonths?: number
    }
    usable: boolean
    timesRedeemed: number
    maxRedemptions?: number
    expiresAt?: number
    firstTimeOnly: boolean
    minimumAmount?: number
    planIds?: string[]
    intervals?: ("month" | "two-year" | "year")[]
    email?: string
    ownerId?: string
    customerId?: string
    createdAt: number
    createdBy?: string
  }
}

Response 200

{
  code: {
    promotionCodeId: string
    code: string
    active: boolean
    couponId: string
    name?: string
    discount: {
      percentOff?: number
      amountOff?: number
      currency?: string
      duration: "once" | "repeating" | "forever"
      durationInMonths?: number
    }
    usable: boolean
    timesRedeemed: number
    maxRedemptions?: number
    expiresAt?: number
    firstTimeOnly: boolean
    minimumAmount?: number
    planIds?: string[]
    intervals?: ("month" | "two-year" | "year")[]
    email?: string
    ownerId?: string
    customerId?: string
    createdAt: number
    createdBy?: string
  }
}

Response 200

{
  ok: true
}

Response 200

{
  redemptions: {
    promotionCodeId: string
    code: string
    ownerId: string
    ownerType: "user" | "org"
    ownerName?: string
    subscriptionId: string
    planId?: string
    interval?: "month" | "two-year" | "year"
    at: number
  }[]
}

Response 200

{
  creators: {
    roles: ("owner" | "admin" | "developer" | "viewer")[]
    emails: string[]
  }
}

Response 200

{
  plans: {
    features?: string[]
    name: string
    createdAt?: number
    updatedAt?: number
    planId: string
    apps?: string[]
    audience?: "personal" | "business"
    tagline?: string
    isDefault?: boolean
    sortOrder?: number
    priceMonthly?: number
    priceAnnual?: number
    priceTwoYear?: number
    offered?: boolean
    trialDays?: number
    support?: string
    highlights?: string[]
    caityMessagesPerDay?: number
    auditRetentionDays: number
    mailSendPerDay?: number
    mailMaxMessageMb?: number
    mailMaxRecipients?: number
    maxConnectors?: number
    maxConnectorTools?: number
    driveStorageGb?: number
    driveStorageGbPerUser?: number
    drivePersonalStorageGb?: number
    vaultMaxItems?: number
    crmMaxRecords?: number
    marketingContacts?: number
    marketingSendsPerMonth?: number
    pipelineMinutes?: number
    pipelineOverage?: boolean
    pipelineConcurrency?: number
    pipelineMaxMinutes?: number
    pipelineLogDays?: number
    pipelineArtifactDays?: number
    pipelineArtifactGb?: number
    pipelineCacheGb?: number
    keysMax?: number
    keyOpsPerMonth?: number
    secretsMax?: number
    keyMonthlyPriceCents?: number
    keyOpsPer10kPriceCents?: number
  }[]
}

Response 200

{
  plan: {
    features?: string[]
    name: string
    createdAt?: number
    updatedAt?: number
    planId: string
    apps?: string[]
    audience?: "personal" | "business"
    tagline?: string
    isDefault?: boolean
    sortOrder?: number
    priceMonthly?: number
    priceAnnual?: number
    priceTwoYear?: number
    offered?: boolean
    trialDays?: number
    support?: string
    highlights?: string[]
    caityMessagesPerDay?: number
    auditRetentionDays: number
    mailSendPerDay?: number
    mailMaxMessageMb?: number
    mailMaxRecipients?: number
    maxConnectors?: number
    maxConnectorTools?: number
    driveStorageGb?: number
    driveStorageGbPerUser?: number
    drivePersonalStorageGb?: number
    vaultMaxItems?: number
    crmMaxRecords?: number
    marketingContacts?: number
    marketingSendsPerMonth?: number
    pipelineMinutes?: number
    pipelineOverage?: boolean
    pipelineConcurrency?: number
    pipelineMaxMinutes?: number
    pipelineLogDays?: number
    pipelineArtifactDays?: number
    pipelineArtifactGb?: number
    pipelineCacheGb?: number
    keysMax?: number
    keyOpsPerMonth?: number
    secretsMax?: number
    keyMonthlyPriceCents?: number
    keyOpsPer10kPriceCents?: number
  }
}

Response 200

{
  templates: {
    templateId: string
    kind: "video" | "document" | "spreadsheet" | "presentation"
    name: string
    category?: string
    sortOrder?: number
    hidden?: boolean
  }[]
}

Response 200

{
  presets: {
    id: string
    label: string
    description?: string
    settings: {
      container: "mp4" | "webm"
      video: null | {
        codec: "av1" | "avc" | "hevc" | "vp9"
        width: number
        height: number
        frameRate: {
          num: number
          den: number
        }
        bitrate: number
        bitrateMode: "variable" | "constant"
        keyframeEvery: number
        profile?: string
        hardware: "no-preference" | "prefer-hardware" | "prefer-software"
      }
      audio: null | {
        codec: "aac" | "opus"
        sampleRate: 48000 | 44100
        channels: 2 | 1
        bitrate: number
      }
      timecodeOverlay?: boolean
      loudness?: null | {
        target: number
        truePeak: number
      }
    }
    sortOrder: number
    hidden: boolean
    builtIn: boolean
  }[]
}

Response 200

{
  preset: {
    id: string
    label: string
    description?: string
    settings: {
      container: "mp4" | "webm"
      video: null | {
        codec: "av1" | "avc" | "hevc" | "vp9"
        width: number
        height: number
        frameRate: {
          num: number
          den: number
        }
        bitrate: number
        bitrateMode: "variable" | "constant"
        keyframeEvery: number
        profile?: string
        hardware: "no-preference" | "prefer-hardware" | "prefer-software"
      }
      audio: null | {
        codec: "aac" | "opus"
        sampleRate: 48000 | 44100
        channels: 2 | 1
        bitrate: number
      }
      timecodeOverlay?: boolean
      loudness?: null | {
        target: number
        truePeak: number
      }
    }
    sortOrder: number
    hidden: boolean
    builtIn: boolean
  }
}

Response 200

{
  fonts: {
    family: string
    category: "serif" | "mono" | "display" | "sans"
    sortOrder: number
    hidden: boolean
    standIn: boolean
  }[]
  hosted: boolean
}

Response 200

{
  font: {
    hidden: boolean
    sortOrder: number
    category: "serif" | "mono" | "display" | "sans"
    family: string
    standIn: boolean
  }
}

Response 200

{
  template: {
    hidden: boolean
    sortOrder: number
    templateId: string
    kind: "video" | "document" | "spreadsheet" | "presentation"
    name: string
    category?: string
  }
}

Response 200

{
  models: {
    region?: string
    label: string
    createdAt?: number
    updatedAt?: number
    api?: "anthropic" | "converse"
    description?: string
    thinking?: "none" | "adaptive" | "budget"
    effort?: "low" | "medium" | "high" | "max" | "xhigh"
    documents?: boolean
    enabled?: boolean
    caity?: boolean
    isDefault?: boolean
    sortOrder?: number
    modelId: string
    thinkingBudget?: number
    maxTokens: number
    eagerToolInput?: boolean
    fallbackModelIds?: string[]
    fallbackModelId?: string
    compactAt?: number
    titles?: boolean
    crossRegion?: boolean
    accessFallback?: boolean
    lane?: "fast" | "balanced" | "deep"
    laneDefault?: boolean
    vision?: boolean
    contextTokens?: number
    price?: unknown
    plans?: string[]
  }[]
}

Response 200

{
  model: {
    region?: string
    label: string
    createdAt?: number
    updatedAt?: number
    api?: "anthropic" | "converse"
    description?: string
    thinking?: "none" | "adaptive" | "budget"
    effort?: "low" | "medium" | "high" | "max" | "xhigh"
    documents?: boolean
    enabled?: boolean
    caity?: boolean
    isDefault?: boolean
    sortOrder?: number
    modelId: string
    thinkingBudget?: number
    maxTokens: number
    eagerToolInput?: boolean
    fallbackModelIds?: string[]
    fallbackModelId?: string
    compactAt?: number
    titles?: boolean
    crossRegion?: boolean
    accessFallback?: boolean
    lane?: "fast" | "balanced" | "deep"
    laneDefault?: boolean
    vision?: boolean
    contextTokens?: number
    price?: unknown
    plans?: string[]
  }
}

Response 200

{
  areas: {
    label: string
    createdAt?: number
    updatedAt?: number
    lat: number
    lon: number
    enabled?: boolean
    sortOrder?: number
    areaId: string
    radiusNm: number
  }[]
}

Response 200

{
  area: {
    label: string
    createdAt?: number
    updatedAt?: number
    lat: number
    lon: number
    enabled?: boolean
    sortOrder?: number
    areaId: string
    radiusNm: number
  }
}

Response 200

{
  sources: {
    createdAt?: number
    updatedAt?: number
    sourceId: string
    enabled?: boolean
    sortOrder?: number
    use?: "all" | "last_resort"
    dailyRequests?: number
    monthlyRequests?: number
  }[]
  known: {
    sourceId: "adsblol" | "adsbfi" | "airplaneslive" | "opensky" | "adsbexchange"
    label: string
    terms: string
    maxRadiusNm: number
    rate: {
      burst: number
      perMinute: number
    }
  }[]
}

Response 200

{
  source: {
    createdAt?: number
    updatedAt?: number
    sourceId: string
    enabled?: boolean
    sortOrder?: number
    use?: "all" | "last_resort"
    dailyRequests?: number
    monthlyRequests?: number
  }
}

Response 200

{
  stages: {
    [key: string]: {
      commit: string
      at: number
    }
  }
  updatedAt: null | number
}

Response 200

{
  settings: {
    on: boolean
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  settings: {
    on: boolean
  }
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  sources: {
    url: string
    format: string
    label: string
    state: string
    attribution: string
    sourceId: string
    enabled: boolean
    sortOrder: number
    pollSeconds: number
    licence: string
    licenceUrl?: string
    homepage?: string
    dedupe: boolean
  }[]
  saved: boolean
  formats: {
    id: string
    label: string
  }[]
  status: {
    sourceId: string
    label: string
    state: "ACT" | "NSW" | "NT" | "QLD" | "SA" | "TAS" | "VIC" | "WA" | "AU"
    attribution: string
    licence: string
    licenceUrl?: string
    homepage?: string
    count: number
    ok: boolean
    checkedAt?: number
    changedAt?: number
    error?: string
  }[]
  updatedAt: null | number
}

Response 200

{
  source: {
    url: string
    format: string
    label: string
    createdAt?: number
    updatedAt?: number
    state: string
    attribution: string
    sourceId: string
    enabled?: boolean
    sortOrder?: number
    pollSeconds?: number
    licence: string
    licenceUrl?: string
    homepage?: string
    dedupe?: boolean
  }
}

Response 200

{
  ok: true
}

Response 200

{
  limits: {
    value: null | number
    updatedAt: null | number
    id: string
    group: string
    label: string
    description?: string
    default: number
    min: number
    max: number
    step?: number
  }[]
}

Response 200

{
  limit: {
    value: null | number
    updatedAt: number
    id: string
    group: string
    label: string
    description?: string
    default: number
    min: number
    max: number
    step?: number
  }
}

Response 200

{
  prices: {
    currency: string
    prices: {
      prefix: string
      country: string
      perPart: number
    }[]
  }
  defaults: {
    currency: string
    prices: {
      prefix: string
      country: string
      perPart: number
    }[]
  }
  stored: boolean
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  prices: {
    currency: string
    prices: {
      prefix: string
      country: string
      perPart: number
    }[]
  }
  defaults: {
    currency: string
    prices: {
      prefix: string
      country: string
      perPart: number
    }[]
  }
  stored: boolean
  updatedAt: null | number
  updatedBy: null | string
}

Response 200

{
  presets: {
    targets: unknown
    label: string
    createdAt?: number
    updatedAt?: number
    enabled?: boolean
    sortOrder?: number
    presetId: string
  }[]
}

Response 200

{
  preset: {
    targets: {
      kind: "type" | "hex" | "callsign" | "registration"
      value: string
    }[]
    label: string
    createdAt?: number
    updatedAt?: number
    enabled?: boolean
    sortOrder?: number
    presetId: string
  }
}

Response 200

{
  ok: true
}

Response 200

{
  rules: {
    value: string
    createdAt?: number
    updatedAt?: number
    match: "header" | "subject" | "domain" | "local"
    ruleId: string
    category: "primary" | "transactions" | "updates" | "promotions"
    enabled?: boolean
    sortOrder?: number
  }[]
}

Response 200

{
  result: {
    category: "primary" | "transactions" | "updates" | "promotions"
    reason: string
    from: string
    subject: string
    domain: string
    local: string
    bulk: boolean
    rule?: {
      ruleId: string
      match: "header" | "subject" | "domain" | "local"
      value: string
      category: "primary" | "transactions" | "updates" | "promotions"
      enabled: boolean
      sortOrder: number
    }
  }
}

Response 200

{
  rule: {
    value: string
    createdAt?: number
    updatedAt?: number
    match: "header" | "subject" | "domain" | "local"
    ruleId: string
    category: "primary" | "transactions" | "updates" | "promotions"
    enabled?: boolean
    sortOrder?: number
  }
}

Response 200

{
  ok: true
}