canonical: https://jentic.com/apis/swaggerhub.volute/volute-plugin-apis
# Volute Plugin APIs
The Volute Plugin APIs allows rapid development of custom tools that automatically integrate within the Volute Worfklow Ecosystem.
. The API exposes 3 endpoints.
## For AI agents
Programmatically fetches analytics for based on filters. see notes on individual parameters below, fetches the available expressions.. Covers 3 operations.
## Scope
Does not handle payments, crm, or developer tools - use for communications only.
## Capabilities
- Fetches analytics for based on filters. See notes on individual parameters below
- Manage communications data programmatically
- Integrate Volute Plugin APIs into automated workflows
- Query and filter Volute Plugin APIs records by parameters
- Monitor Volute Plugin APIs operational status and events
## Use cases
### Communications Operations
Use the Volute Plugin APIs to perform communications operations programmatically. The API provides 3 endpoints covering core functionality including fetches analytics for based on filters. see notes on individual parameters below, fetches the available expressions., fetches the available context types..
Example prompt: Call GET `/analytics/reporting` to fetches analytics for based on filters. see notes on individual parameters below
### Automated Auth Management
Automate auth operations by combining multiple Volute Plugin APIs endpoints. Agents can fetches the available expressions. and then fetches the available context types. in a single workflow.
Example prompt: Call GET `/analytics/reporting/expressions` to fetches the available expressions., then verify the result
### AI Agent Integration via Jentic
AI agents discover and call Volute Plugin APIs endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.
Example prompt: Search Jentic for 'fetches analytics for based on filters. see notes on individual parameters below', load the operation schema, and execute with Jentic-managed credentials
## Key endpoints
| Method | Path | Description |
| --- | --- | --- |
| GET | `/analytics/reporting` | Fetches analytics for based on filters. See notes on individual parameters below |
| GET | `/analytics/reporting/expressions` | Fetches the available expressions. |
| GET | `/analytics/reporting/contexttypes` | Fetches the available context types. |
## Key resources
- **Auth** — Volute Plugin API implements the industry standard OAuth 2.0 protocol for authoring requests, see [h
- **Users** — User services provide operations to interact with our Users system.
- **Tools** — Tool services provide operations to interact with our Tools system.
- **Analytics** — Analytic services provide operations to interact with our Analytics system.
- **ActivityStreams** — Stream services provides operations to interact with Notification and Social Activity streams. We im
## Why Jentic
- **Setup:** Wiring Volute Plugin APIs by hand still means reading its reporting parameters, building the reporting, expressions, and context-types requests, and parsing the responses yourself. Through Jentic you install once, import Volute Plugin APIs from the API Directory, and your agent calls it.
- **Permission scoping:** Volute Plugin APIs exposes read-only reporting operations and the filters travel as query parameters, so scope with operations-only language: limit the agent to the operations it needs, such as fetching a report or listing reporting context types. You choose the operations it may call, so nothing beyond that set is reachable.
- **Credential handling:** Volute Plugin APIs requires no credential to call, so there is no secret to store; if that changes, any credential you add is stored once, encrypted, by your own Jentic One instance and injected at execution time. No secret enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'fetch an analytics report' or 'list reporting context types', and Jentic returns the matching Volute Plugin APIs operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
## Related APIs
- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API
## FAQ
### What authentication does the Volute Plugin APIs use?
The Volute Plugin APIs uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
### Can I fetches analytics for based on filters. see notes on individual parameters below with the Volute Plugin APIs?
Yes. Use the GET `/analytics/reporting` endpoint. The API returns structured JSON responses that agents can parse and act on directly.
### What are the rate limits for the Volute Plugin APIs?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
### How do I fetches analytics for based on filters. see notes on individual parameters below through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'fetches analytics for based on filters. see notes on individual parameters below'. Jentic returns the matching Volute Plugin APIs operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
### How many endpoints does the Volute Plugin APIs have?
The Volute Plugin APIs exposes 3 endpoints covering auth, users, tools operations.
### Can I limit what my agent is allowed to do with the Volute Plugin APIs?
Yes. Because Jentic One is self-hosted, you set the rules that decide which operations your agent may call, and the Volute Plugin APIs exposes only read-only reporting operations: fetching a report, listing available expressions, and listing reporting context types. Limit the agent to just the operations it needs, such as fetching a report, and nothing outside that set is reachable. The report filters travel as query parameters, so you control exactly which reporting calls the agent can make.