DEVELOPER API

A partner platform, not just an internal endpoint list.

The core VetIOS APIs now have published products, self-serve onboarding intake, quota-metered partner credentials, lifecycle analytics, and a versioned external contract.

OverviewCIRE StandardModel CardsDevelopersPassive SignalsNetwork LearningPopulation IntelligencePetPassEdge Box
JSON contractJSON catalogOpenAPI YAMLInternal explorerOpen console
Documented endpoints
13
Contract version
1.0.0
Published products
0
Configuration needed

Set VETIOS_PUBLIC_TENANT_ID to publish partner products and accept public onboarding requests from the canonical tenant.

Published products
No partner API products have been published yet.
Endpoint catalog
POSTLIVE

/api/inference

Auth: service account

Execute routed veterinary inference and return differentials, uncertainty, telemetry, and lineage.

Operational notes
Registry-aware route planning and telemetry are already applied in the request path.
Supports scoped machine credentials for partner or server-to-server inference.
Sample payload
{
  "model": {
    "name": "VetIOS Diagnostics",
    "version": "latest"
  },
  "input": {
    "input_signature": {
      "species": "Canis lupus familiaris",
      "breed": "Golden Retriever",
      "symptoms": [
        "lethargy",
        "vomiting"
      ],
      "metadata": {
        "age_years": 4
      }
    }
  }
}
POSTLIVE

/api/outcome

Auth: service account

Attach clinician-grounded outcomes to prior inference events and feed the learning loop.

Operational notes
This is the core data-flywheel closeout surface.
Sample payload
{
  "inference_event_id": "11111111-1111-4111-8111-111111111111",
  "outcome": {
    "type": "confirmed_diagnosis",
    "payload": {
      "label": "canine_pancreatitis",
      "confidence": 0.94,
      "confirmed_diagnosis": "canine_pancreatitis",
      "primary_condition_class": "gastrointestinal"
    },
    "timestamp": "2026-04-01T00:00:00.000Z"
  }
}
POSTLIVE

/api/dataset/case-import

Auth: service account

Validate and import de-identified, outcome-labeled real clinical cases into the learning dataset.

Operational notes
Requires outcome:write scope plus tenant-level or per-case deidentified training consent.
Rejects direct identifiers such as owner contact, patient names, microchip IDs, emails, and phone numbers before creating learning-ready cases.
Supports dry_run for clinic data onboarding reviews before any case rows are written.
Sample payload
{
  "dry_run": true,
  "source_name": "pilot_clinic_export",
  "cases": [
    {
      "source_case_reference": "pilot-2026-0001",
      "usage_class": "internal_deidentified",
      "deidentified": true,
      "patient": {
        "species": "canine",
        "breed": "Labrador Retriever",
        "age_years": 7,
        "weight_kg": 32.5,
        "sex": "female_spayed",
        "deidentified_patient_ref": "hash:7b6c"
      },
      "presenting_complaint": "acute lethargy and pale mucous membranes",
      "symptoms": [
        "tachycardia",
        "dark urine",
        "jaundice"
      ],
      "confirmed_diagnosis": "immune-mediated hemolytic anemia",
      "diagnosis_method": "lab_confirmed",
      "diagnosis_confidence": 0.98,
      "primary_condition_class": "hematologic",
      "learning_consent": {
        "deidentified_training": true
      }
    }
  ]
}
POSTLIVE

/api/simulate

Auth: service account

Run adversarial or boundary-condition simulations through the inference pipeline.

Operational notes
Useful for safety regression and failure probing before promotion.
Sample payload
{
  "steps": 5,
  "mode": "adaptive",
  "base_case": {
    "species": "canine",
    "breed": "mixed",
    "symptoms": [
      "fever",
      "lethargy",
      "nasal discharge",
      "cough"
    ],
    "metadata": {
      "target_disease": "canine_distemper",
      "edge_cases": [
        "hypothermia_plus_fever"
      ],
      "labs": {
        "wbc": 3.8,
        "lymphocytes": 0.7
      }
    }
  },
  "inference": {
    "model": "VetIOS Diagnostics",
    "model_version": "latest"
  }
}
POSTLIVE

/api/evaluation

Auth: service account

Create an aggregate tenant evaluation snapshot for confidence calibration and model review.

Operational notes
POST is accepted as an operational alias for the aggregate evaluation read path.
Feeds model assessment and governance review workflows.
Sample payload
{
  "model_name": "VetIOS Diagnostics",
  "model_version": "aggregate",
  "predicted_confidence": 0.82,
  "trigger_type": "inference"
}
POSTINTERNAL ONLY

/api/signals/connect

Auth: connector key

Normalize passive vendor connector payloads and attach them to episodes.

Operational notes
Supports lab results, refills, rechecks, referrals, and imaging reports today.
PIMS workflow payloads can provide workflow_event_type instead of connector_type; VetIOS maps ezyVet/Covetrus-style events into the passive connector contract.
Supports connector marketplace installations and installation-scoped credentials, with the older shared-secret path still present only for legacy traffic.
Sample payload
{
  "connector": {
    "workflow_event_type": "appointment.completed",
    "clinic_id": "clinic_123",
    "patient_id": "00000000-0000-0000-0000-000000000000",
    "vendor_name": "ezyVet",
    "payload": {
      "appointment_status": "completed",
      "start_at": "2026-05-23T15:00:00.000Z",
      "reason": "IMHA follow-up recheck",
      "primary_condition_class": "hematologic"
    }
  }
}
GETPUBLIC

/api/public/model-cards

Auth: public

Read-only public registry and governance catalog.

Operational notes
Designed for transparency and external trust review.
GETPUBLIC

/api/public/network-learning

Auth: public

Read-only learning-loop health and dataset compounding snapshot.

Operational notes
Summarizes dataset versions, benchmark runs, calibration reports, and audit activity.
GETPUBLIC

/api/public/population-intelligence

Auth: public

Read-only aggregate population-health advisory feed for public-health safe disease surveillance.

Operational notes
Suppresses low-support signals below the minimum clinic threshold.
Excludes tenant IDs, clinic identifiers, patient identifiers, owner identifiers, and inference event IDs.
GETPUBLIC

/api/public/cire-standard

Auth: public

Publish the versioned CIRE reliability standard for phi_hat, CPS, safety states, and inference lineage.

Operational notes
This is intentionally open so external researchers and partners can cite the reliability contract.
Managed VetIOS deployments provide hosted lineage, outcome loops, model cards, and enterprise SLA support around the standard.
GETPUBLIC

/api/public/cire-conformance

Auth: public

Publish the reference CIRE conformance fixture and validation result for third-party compatibility checks.

Operational notes
External implementers can run this report through @vetios/cire-engine or their own validator.
Passing the fixture does not certify clinical safety; it proves compatibility with the public CIRE signal contract.
GETPUBLIC

/api/public/cire-certifications

Auth: public

Read the public CIRE implementation certification registry without exposing tenant or clinic details.

Operational notes
Only explicitly public, passing conformance events are listed.
The registry is append-only and backed by signed payload hashes where provided.
GETPUBLIC

/api/public/cire-operational-proof

Auth: public

Read public-safe CIRE operating evidence for cron execution, certification registry population, migration targets, and calibration runs.

Operational notes
Summarizes append-only operational proof events without exposing tenant, clinic, patient, owner, or credential details.
Designed to distinguish a paper standard from a running reliability substrate with auditable proof digests.
Versioned contract

Partner integrations can now pin against the VetIOS 1.0.0 contract, inspect quota headers, and validate API-key scopes before writing production traffic.

JSON developer contractGenerated OpenAPI YAMLOpenAPI JSON
Self-serve onboarding

Request partner access

Submit a partner use case and requested products. The admin control plane can approve it and mint a scoped machine credential.

Open requests
0
Active partners
0
Tenant source
NOT CONFIGURED