canonical: https://jentic.com/apis/clinicos.vet/clinicos # Clinicos Vet PawthosX.Business.API | v1 Jentic publishes the only available OpenAPI specification for PawthosX.Business.API, keeping it validated and agent-ready. PawthosX is the business API behind ClinicOS, a veterinary practice management platform, and it exposes 590 endpoints covering appointments, cases, clients and patients, inventory, payments, prescriptions, lab panels, surgical records, scheduling, and clinic configuration. Authentication supports a Bearer token and an X-API-Key header, and the surface includes both interactive workflows (clocking in, kiosk, telnyx call control) and bulk export endpoints for clients and patients. ## For AI agents Run a veterinary practice on the ClinicOS PawthosX API - manage appointments, patients, clients, inventory, payments, prescriptions, surgical records, and clinic operations across 590 endpoints. ## Scope Does not handle insurance claims, lab analyser hardware control, or imaging DICOM transfers - use for ClinicOS PawthosX practice management workflows only. ## Capabilities - Schedule, check in, complete, or cancel appointments via `/Appointments/{id}/check-in`, `/Appointments/{id}/complete`, and `/Appointments/{id}/cancel` - Manage client and patient records and run bulk exports via /Clients, /Patients, and /BulkClientExport endpoints - Track cases and case milestones for ongoing treatment via /Cases and /CaseMilestones endpoints - Capture vitals, vaccinations, lab panels, and surgical records via /Vitals, /Vaccinations, /LabPanels, /Labs, and /SurgicalRecords endpoints - Process payments and payment tokens at point of care via /Payments and /PaymentTokens endpoints - Manage inventory, retail items, vendors, and purchase orders via /Inventory, /RetailItems, /Vendors, and /PurchaseOrders endpoints - Run staff clocking, shifts, time entries, and PTO requests via /Clocking, /Shifts, /TimeEntries, and /PtoRequests endpoints ## Use cases ### Appointment Lifecycle in a Veterinary Clinic Run the full appointment lifecycle from scheduling to discharge by composing /Appointments creation with `/Appointments/{id}/check-in`, `/Appointments/{id}/start`, `/Appointments/{id}/complete`, and `/Appointments/{id}/discharge.` `/Appointments/{id}/dispensed-items` captures medication and retail items dispensed during the visit so billing reconciles automatically. Example prompt: Create an appointment via POST /Appointments, check the patient in via `/Appointments/{id}/check-in`, complete the visit via `/Appointments/{id}/complete`, and capture dispensed items in `/Appointments/{id}/dispensed-items.` ### Clinical Records and Care Documentation Capture the clinical record across vitals, vaccinations, lab panels, surgical records, and case milestones so the patient file stays complete. The /Vitals, /Vaccinations, /LabPanels, /Labs, /SurgicalRecords, /CaseMilestones, and /Cases endpoints together support the documentation a vet needs during and after a visit. Example prompt: Record a vitals reading via POST /Vitals against the appointment, log a vaccination via POST /Vaccinations, and add a case milestone via POST /CaseMilestones. ### Inventory, Pharmacy, and Purchase Ordering Keep dispensary stock accurate by tracking retail items, inventory locations, vendors, and purchase orders, with RX governance for controlled substances. The /Inventory, /InventoryLocations, /InventoryApprovals, /RetailItems, /Vendors, /PurchaseOrders, /Pharmacies, and /RxGovernance endpoints support clinic operations and compliance together. Example prompt: Create a purchase order via POST /PurchaseOrders for low-stock retail items and approve it via /InventoryApprovals once received. ### Staffing, Scheduling, and Clocking Run rota, attendance, and timekeeping for the clinic team through /Shifts, /ShiftSwaps, `/Clocking/in`, `/Clocking/out`, /TimeEntries, /PtoRequests, and /RoomDayAssignments. The endpoints together support both day-of operations like clocking in and longer-horizon planning like PTO. Example prompt: Clock a tech in via POST `/Clocking/in`, assign them to a room via /RoomDayAssignments, and post a time entry via /TimeEntries at end of shift. ### AI Agent Front Desk via Jentic An AI agent acting as a virtual front desk can book appointments, send reminders, capture intake forms, and process payments by searching Jentic for the matching PawthosX operation. Jentic securely stores both the Bearer token and the X-API-Key so the agent only ever holds scoped execution rights. Example prompt: Use the Jentic search query 'book a vet appointment' to find POST /Appointments and execute with the client, patient, and time slot details. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/Appointments` | Create a new appointment | | POST | `/Appointments/{id}/check-in` | Check a patient in for an appointment | | POST | `/Appointments/{id}/complete` | Mark an appointment complete | | POST | `/Vitals` | Record vital signs | | POST | `/Vaccinations` | Record an administered vaccination | | POST | `/Payments` | Process a payment at point of care | | POST | `/PurchaseOrders` | Create a purchase order for inventory | | POST | `/Clocking/in` | Clock a staff member in for a shift | ## Key resources - **Appointments** — Schedule, check in, start, complete, discharge, and cancel appointments - **Patients** — Manage patient records, masses, and bulk exports - **Clients** — Manage client records and bulk client exports - **Cases** — Track ongoing cases and case milestones - **Inventory** — Manage inventory, retail items, vendors, and purchase orders - **Payments** — Process payments and payment tokens at point of care - **Vaccinations** — Record administered vaccinations against patient records - **Surgical Records** — Capture surgical record details for the patient file - **Clocking** — Clock staff in and out and capture lunch breaks - **Shifts** — Manage shifts, swaps, and PTO requests ## Why Jentic - **Setup:** Wiring ClinicOS PawthosX by hand means carrying both a Bearer token and an X-API-Key, mapping practice-management endpoints across appointments, vitals, and payments, and handling retries yourself against api.clinicos.vet. Through Jentic you install once, import the PawthosX API from the API Directory, store both credentials once, and your agent calls it. - **Permission scoping:** PawthosX puts the appointment id in the URL path (`/Appointments/{id}/...`), so a rule can pin your agent to one appointment: it can check that appointment in or complete it and nothing else. You choose the operations it may call, so recording payments or purchase orders are not included unless you add them. - **Credential handling:** Your PawthosX Bearer token and X-API-Key are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'book a vet appointment' or 'record a vaccination', and Jentic returns the matching PawthosX operation with its input schema, so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Salesforce Health Cloud** — Healthcare CRM with appointments and patient records on a generic platform - **Stripe** — Payment processing for card-present and card-not-present payments - **Twilio** — SMS and voice communications API ## FAQ ### Why is there no official OpenAPI spec for PawthosX.Business.API? ClinicOS does not publish a structured OpenAPI specification for PawthosX. Jentic generates and maintains this spec so that AI agents and developers can call PawthosX.Business.API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the PawthosX API use? The API supports a Bearer token in the Authorization header and an X-API-Key header for service-to-service flows. Through Jentic both credentials are stored encrypted in the vault and the agent only sees a scoped execution context. ### Can I record a vaccination against a patient with the API? Yes. POST to /Vaccinations with the patient ID, product, dose, and administering staff member, and the vaccination becomes part of the patient's medical record visible at the next visit. ### Can I run the full appointment lifecycle through the API? Yes. /Appointments handles creation and updates, `/Appointments/{id}/check-in` marks arrival, `/Appointments/{id}/start`, `/Appointments/{id}/complete`, and `/Appointments/{id}/discharge` progress the visit, and `/Appointments/{id}/dispensed-items` captures items billed. ### How do I book an appointment through Jentic? Search Jentic for 'book a vet appointment', load the schema for POST /Appointments, and execute with client ID, patient ID, and the requested time slot. The Python SDK uses await client.search, await client.load, await client.execute. ### Can I bulk export client and patient data? Yes. /BulkClientExport, /BulkPatientExport, /ClientExport, /PatientRecordExport, /DeaExport, and /ChatExport endpoints generate full record exports for accounting, audits, and migrations. ### Can I limit what my agent is allowed to do with the PawthosX API? Yes. Because you run Jentic One yourself, your own rules decide which PawthosX operations and credentials the agent may use. Since PawthosX puts the appointment id in the URL path (`/Appointments/{id}/...`), you can pin the agent to a single appointment so it can only check that one in or complete it. You choose the operations it may call, so recording payments via /Payments or creating purchase orders via /PurchaseOrders stay off-limits unless you add them.