Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Sirportly API, 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%2Fsirportly.com%2Fsirportly" | 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%2Fsirportly.com%2Fsirportly" | 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 Sirportly API.
List all tickets
Submit a new ticket
Search tickets
Query and filter Sirportly API records by parameters
Monitor Sirportly API operational status and events
GET STARTED
Patterns agents use Sirportly API for, with concrete tasks.
★ CRM Operations
Use the Sirportly API to perform crm operations programmatically. The API provides 4 endpoints covering core functionality including list all tickets, submit a new ticket, search tickets.
Call GET /api/v2/tickets/all to list all tickets
Automated Tickets Management
Automate tickets operations by combining multiple Sirportly API endpoints. Agents can submit a new ticket and then search tickets in a single workflow.
Call POST /api/v2/tickets/submit to submit a new ticket, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Sirportly API 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 apiKey tokens manually.
Search Jentic for 'list all tickets', load the operation schema, and execute with Jentic-managed credentials
4 endpoints — sirportly helpdesk and ticketing system rest api for managing tickets, ticket updates, contacts, and related resources.
METHOD
PATH
DESCRIPTION
/api/v2/tickets/all
List all tickets
/api/v2/tickets/submit
Submit a new ticket
/api/v2/tickets/search
Search tickets
/api/v2/ticket_updates/all
List all updates for a ticket
/api/v2/tickets/all
List all tickets
/api/v2/tickets/submit
Submit a new ticket
/api/v2/tickets/search
Search tickets
/api/v2/ticket_updates/all
List all updates for a ticket
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Sirportly API by hand means setting up its paired token and secret headers, X-Auth-Token and X-Auth-Secret, and carrying both across every ticket call yourself. Through Jentic you install once, import Sirportly from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
Sirportly carries its ticket targets in the request body rather than as a resource id in the URL path, so scope the agent by operations: limit it to the operations it needs, such as listing or searching tickets, and leave out ticket submission unless you add it.
Credential isolation
Your Sirportly token and secret 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.
Intent-based discovery
Agents search Jentic by intent such as 'list all tickets' or 'search tickets', and Jentic returns the matching Sirportly 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 Sirportly API through Jentic.
What authentication does the Sirportly API use?
The Sirportly API uses an API key passed in the `X-Auth-Token` header. 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 all tickets with the Sirportly API?
Yes. Use the GET /api/v2/tickets/all endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Sirportly API?
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 all tickets through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list all tickets'. Jentic returns the matching Sirportly API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Sirportly API have?
The Sirportly API exposes 4 endpoints covering tickets, ticketupdates operations.
Can I limit what my agent is allowed to do with the Sirportly API?
Yes. Because you run Jentic One yourself, your own rules decide which Sirportly operations and credentials the agent may use. Since Sirportly identifies its ticket targets in the request body rather than in the URL path, you scope the agent by operation: allow only what it needs, such as listing tickets with GET /api/v2/tickets/all, searching with POST /api/v2/tickets/search, or reading updates with GET /api/v2/ticket_updates/all, and leave out ticket submission via POST /api/v2/tickets/submit unless you grant it. The stored token and secret are injected only for the operations you permit.
For Agents
Programmatically list all tickets, submit a new ticket. Covers 4 operations with apiKey authentication.
Use for: I need to all tickets, I want to submit a new ticket, Search for tickets, Find all all updates for a ticket
Not supported: Does not handle payments, communications, or developer tools - use for crm only.
Sirportly helpdesk and ticketing system REST API for managing tickets, ticket updates, contacts, and related resources. The API exposes 4 endpoints secured with apiKey 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>