canonical: https://jentic.com/apis/riosulweb.com.br/riosulweb

# Riosulweb AgendaFacil API

The AgendaFacil API books, confirms, reschedules, and cancels patient appointments at clinics on the AgendaFacil scheduling system, and is built for a WhatsApp booking bot. It checks a patient by CPF and registers new patients, lists active clinics and online professional profiles with their procedures and prices, and returns available slots per profile and date. After booking, it can return a patient's exam results once the CPF and password are validated, list card installments, and generate a PIX copy-and-paste code or a credit card payment link for the appointment. The server published in the spec is a sandbox that uses test data.

## For AI agents

Run a clinic booking assistant on AgendaFacil: look up patients by CPF, find open slots by profile and date, book, confirm, reschedule, or cancel appointments, and generate PIX or card payment links.

## Scope

Does not send WhatsApp messages, store full medical records, or bill insurance plans. Use for booking, confirming, rescheduling, and taking payment for AgendaFacil clinic appointments only.

## Capabilities

- Check whether a patient exists by CPF and register new patients with nome, dataNascimento, cpf, sexo, and telefone1
- List active clinics and online professional profiles with their procedures and prices
- Find available appointment slots for a profile on a given date via perfilId and data
- Book an appointment with agendaId, pacienteId, inicio, possuiPlano, and procedimentos, and validate procedure prices first
- Confirm, reschedule to another agenda, or cancel an existing appointment by id
- List appointments awaiting confirmation so a bot can send reminders
- Generate a PIX copy-and-paste code or a credit card payment link for an appointment payment

## Use cases

### AI booking assistant for a clinic

A developer building a WhatsApp or chat assistant for a clinic wants their agent to book visits without holding the clinic's integration token. Through Jentic the agent searches by intent, gets the availability and booking operations with their input schemas, and calls them with the ds-access-token header injected at execution time. It checks the patient by CPF, finds an open slot for the requested profile, and creates the appointment.

Example prompt: Call GET `/client/roboVerificaCpf` with the patient's cpf, then GET `/agendas/disponibilidadeporperfilwhatsapp` with perfilId 12 and data '2026-11-24', then POST `/onlineAppointment/robowhatsapp` with agendaId, pacienteId, inicio, possuiPlano false, and procedimentos

### Confirmation reminders and no-show reduction

Clinics lose time to appointments patients forget. GET `/agendamentos/robowhatsapp/aconfirmar` returns appointments pending confirmation, a bot sends each patient a message, and PUT `/onlineAppointment/robowhatsapp/confirmar/{id}` confirms the ones the patient accepts. Patients who cannot make it can be moved with PATCH `/onlineAppointment/remarcar/robowhatsapp/{id}` or cancelled with DELETE `/onlineAppointment/cancelar/robowhatsapp/{id}.`

Example prompt: List pending confirmations via GET `/agendamentos/robowhatsapp/aconfirmar`, and for appointment 4521 call PUT `/onlineAppointment/robowhatsapp/confirmar/{id}` after the patient replies yes

### Collecting payment for a visit

Some clinics take payment before the visit. PUT `/onlineAppointment/robowhatsapp/intencaopagamento/{id}` marks an appointment for payment, PUT `/caixa/pagamentoonline/pix/robowhatsapp/{pagamentoId}` generates a PIX copy-and-paste code from transaction_amount, description, external_reference, and payer, and PUT `/caixa/pagamentoonline/cartaocredito/robowhatsapp/{pagamentoId}` returns a credit card payment link.

Example prompt: Mark appointment 4521 for payment via PUT `/onlineAppointment/robowhatsapp/intencaopagamento/{id}`, then call PUT `/caixa/pagamentoonline/pix/robowhatsapp/{pagamentoId}` with transaction_amount 150.0, a description, an external_reference, and the payer

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/client/roboVerificaCpf` | Check a patient by CPF |
| GET | `/agendas/disponibilidadeporperfilwhatsapp` | Availability by profile |
| POST | `/onlineAppointment/robowhatsapp` | Create an appointment |
| PUT | `/onlineAppointment/robowhatsapp/confirmar/{id}` | Confirm an appointment |
| PATCH | `/onlineAppointment/remarcar/robowhatsapp/{id}` | Reschedule an appointment |
| DELETE | `/onlineAppointment/cancelar/robowhatsapp/{id}` | Cancel an appointment |
| PUT | `/caixa/pagamentoonline/pix/robowhatsapp/{pagamentoId}` | Generate a PIX payment code |

## Key resources

- **Patients** — Check a patient by CPF, register new patients, and check whether a patient has had an appointment
- **Clinics and profiles** — Active clinics and online professional profiles with procedures and prices
- **Availability and appointments** — Slots per profile and date, booking, procedure validation, confirmation, rescheduling, and cancellation
- **Exams and payments** — Exam results after CPF and password validation, card installments, PIX codes, and card payment links

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 42 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 60 / 100
  - Developer Experience & Jentic Compatibility: 72 / 100
  - AI-Readiness & Agent Experience: 19 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 70 / 100
- **View full report:** https://jentic.com/apis/riosulweb.com.br/riosulweb/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring AgendaFacil by hand means sending the ds-access-token header, chaining a CPF check, availability lookup, and procedure validation before each booking, and pointing at the right host since the spec lists only a sandbox. Through Jentic you install once, import AgendaFacil from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** AgendaFacil puts the appointment id and payment id in the URL path, as in `/onlineAppointment/robowhatsapp/confirmar/{id}`, so a rule can pin your agent to the appointment operations it needs. You choose the operations it may call, so sensitive ones like reading exam results or cancelling an appointment are not included unless you add them.
- **Credential handling:** Your AgendaFacil integration token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'book a clinic appointment' or 'confirm an appointment', and Jentic returns the matching AgendaFacil operation with its input schema, including required Portuguese-named fields like agendaId, pacienteId, and inicio.

## Related APIs

- **Dentally API** — Dental practice management with patients, appointments, and invoices
- **Calendly API** — General meeting scheduling with event types and invitees
- **Zenvia APIs** — Messaging over WhatsApp, SMS, and other channels in Brazil

## FAQ

### What authentication does the AgendaFacil API use?

Per its OpenAPI spec, the AgendaFacil API authenticates with an API key sent in the ds-access-token request header, the integration token for the WhatsApp robot. Some operation descriptions also refer to the robot token as an Authorization Bearer value, so confirm the header with the provider. Through Jentic the token is stored by your own Jentic One instance and attached at call time.

### Can I reschedule an appointment with the AgendaFacil API?

Yes. PATCH `/onlineAppointment/remarcar/robowhatsapp/{id}` moves an existing appointment to another agenda and needs agendaId and inicio in the body. To find a new slot first, call GET `/agendas/disponibilidadeporperfilwhatsapp` with perfilId and data.

### What are the rate limits for the AgendaFacil API?

The OpenAPI spec does not specify rate limits, and its only server is a sandbox that uses test data. Ask the clinic system provider at riosulweb.com.br for production hosts and limits before going live.

### Is there an AgendaFacil MCP server?

You don't need an MCP server to give your agent AgendaFacil. Jentic connects it directly from the API Directory: import it, store your integration token once, and your agent calls the booking, confirmation, and payment operations on demand without another server's tool definitions in its context.

### How do I book a clinic appointment through Jentic?

Search Jentic for 'book a clinic appointment', check the patient with GET `/client/roboVerificaCpf`, find a slot with GET `/agendas/disponibilidadeporperfilwhatsapp`, then execute POST `/onlineAppointment/robowhatsapp` with agendaId, pacienteId, inicio, possuiPlano, and procedimentos. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I limit what my agent is allowed to do with the AgendaFacil API?

Yes. For a reminder bot, write a rule that allows GET `/agendamentos/robowhatsapp/aconfirmar` and PUT `/onlineAppointment/robowhatsapp/confirmar/{id}.` It can list and confirm appointments but cannot cancel them, read exam results, or generate payments, and every call it makes is logged.
