Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ProsperStack API Reference, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fprosperstack.com%2Fprosperstack" | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fprosperstack.com%2Fprosperstack" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
What an agent can do with ProsperStack API Reference API.
List events
Retrieve an event
Create a customer portal session
Patterns agents use ProsperStack API Reference API for, with concrete tasks.
★ CRM Operations
Use the ProsperStack API Reference to perform crm operations programmatically. The API provides 29 endpoints covering core functionality including list events, retrieve an event, create a customer portal session.
GET STARTED
Call GET /events to list events
Automated flows Management
Automate flows operations by combining multiple ProsperStack API Reference endpoints. Agents can retrieve an event and then create a customer portal session in a single workflow.
Call GET /events/{id} to retrieve an event, then verify the result
AI Agent Integration via Jentic
AI agents discover and call ProsperStack API Reference 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 basic tokens manually.
Search Jentic for 'list events', load the operation schema, and execute with Jentic-managed credentials
29 endpoints — this is the reference documentation for the prosperstack api v1.
METHOD
PATH
DESCRIPTION
/events
List events
/events/{id}
Retrieve an event
/customer_portal/sessions
Create a customer portal session
/flows
List flows
/flows/{id}
Retrieve a flow
/flow_sessions
List flow sessions
/flow_sessions/{id}
Retrieve a flow session
/offers
List offers
/events
List events
/events/{id}
Retrieve an event
/customer_portal/sessions
Create a customer portal session
/flows
List flows
/flows/{id}
Retrieve a flow
/flow_sessions
List flow sessions
/flow_sessions/{id}
Retrieve a flow session
/offers
List offers
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the ProsperStack API by hand means encoding basic auth on every request and paging through events, flows, and offers yourself. Through Jentic you install once, import ProsperStack from the API Directory, store the credential once, and your agent calls it.
Permission scoping
ProsperStack puts the resource id in the URL path (/flows/{id}, /events/{id}, /flow_sessions/{id}), so a rule can pin your agent to reading a specific flow or event. You choose the operations it may call, so writes like creating a customer portal session are not included unless you add them.
Credential isolation
Your ProsperStack API credential 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.
Intent-based discovery
Agents search Jentic by intent such as 'list events' or 'read a cancellation flow', and Jentic returns the matching ProsperStack operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Alternatives and complements available in the Jentic catalogue.
Specific to using ProsperStack API Reference API through Jentic.
What authentication does the ProsperStack API Reference use?
The ProsperStack API Reference uses HTTP Basic authentication with username and password. 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 list events with the ProsperStack API Reference?
Yes. Use the GET /events endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the ProsperStack API Reference?
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 list events through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list events'. Jentic returns the matching ProsperStack API Reference operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the ProsperStack API Reference have?
The ProsperStack API Reference exposes 29 endpoints covering flows, flow_sessions, offers operations.
Can I limit what my agent is allowed to do with the ProsperStack API?
Yes. Because you run Jentic One yourself, you decide which ProsperStack operations your agent may call, so read-only endpoints like GET /events, GET /flows, and GET /flow_sessions can be allowed while a write such as creating a customer portal session stays off unless you add it. Since ProsperStack puts the resource id in the URL path, such as /flows/{id} or /events/{id}, your rules can pin the agent to reading one specific flow, event, or flow session. The stored credential is injected only when an operation you permitted runs.
For Agents
Programmatically list events, retrieve an event. Covers 29 operations with basic authentication.
Use for: I need to events, I want to an event, Search for a customer portal session, Find all flows
Not supported: Does not handle payments, communications, or developer tools - use for crm only.
This is the reference documentation for the ProsperStack API v1. Visit ProsperStack at [prosperstack.com](https://prosperstack.com). For more information on ProsperStack features, see the [primary documentation](https://prosperstack.com/docs/). Let us know how we can improve the API, documentation or anything else you need help with at [support@prosperstack.com](mailto:support@prosperstack.com). I. The API exposes 29 endpoints secured with basic authentication.
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.
Base layer of spec validity and structural soundness.
Aggregated quality score from linter diagnostics, weighted by severity.
Percentage of `$ref` references that resolve successfully.
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
Structural correctness score based on schema issues using logarithmic dampening.
Clarity, completeness, and ingestion readiness for developers and tooling.
How richly the API is illustrated with examples.
Percentage of examples that conform to their schemas.
Percentage of operations with complete response definitions (success, client error, server error).
Health of API ingestion, bundling, and resolution within Jentic pipelines.
Semantic breadth, depth, and agent comprehension for AI systems.
Coverage of descriptions across API elements.
Coverage of RFC 9457 Problem Details for error responses.
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
Coverage of summaries across operations/tags/info.
Functional utility, complexity comfort, and AI orchestration readiness.
Agent comfort level based on API operational and structural complexity.
Trust, risk posture, and security compliance.
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
Findability, semantic richness, and reasoning readiness.
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>