Symphony Agent API
68
AI ReadinessAI-Aware (B+)68/100
Official vendor OpenAPI document · agent-readyIdentity AuthAuthenticationnone56 EndpointsREST
For Agents
Programmatically checks health status, checks health status of services and users. Covers 56 operations.
Use for: I need to checks health status, I want to checks health status of services and users, Search for import messages from other systems into symphony., Find all post a message to multiple existing streams.
Not supported: Does not handle payments, communications, or crm - use for identity and authentication only.
This document refers to Symphony API calls to send and receive messages and content. They need the on-premise Agent installed to perform decryption/encryption of content. - sessionToken and keyManagerToken can be obtained by calling the authenticationAPI on the symphony back end and the key manager respectively. Refer to the methods described in authenticatorAPI.yaml. - Actions are defined to be a. The API exposes 56 endpoints.
Install Jentic One Beta
Connect the Agent API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Agent 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.
1
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%2Fsymphony.com%2Fsymphony" | sh2
Step 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%2Fsymphony.com%2Fsymphony" | 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.
Capabilities
What an agent can do with Agent API.
Checks health status
Import messages from other systems into Symphony.
Post a message to multiple existing streams.
Get a message by ID
Search messages
Use Cases
Patterns agents use Agent API for, with concrete tasks.
★ Identity and Authentication Operations
Use the Agent API to perform identity auth operations programmatically. The API provides 56 endpoints covering core functionality including checks health status, checks health status of services and users, import messages from other systems into symphony..
Call GET /v3/health to checks health status
Automated Attachments Management
Automate attachments operations by combining multiple Agent API endpoints. Agents can checks health status of services and users and then import messages from other systems into symphony. in a single workflow.
Call GET /v3/health/extended to checks health status of services and users, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Agent 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 none tokens manually.
Search Jentic for 'checks health status', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
56 endpoints — this document refers to symphony api calls to send and receive messages and content.
METHOD
PATH
DESCRIPTION
GET
/v3/health
Checks health status
GET
/v3/health/extended
Checks health status of services and users
POST
/v4/message/import
Import messages from other systems into Symphony.
POST
/v4/message/blast
Post a message to multiple existing streams.
GET
/v1/message/{id}
Get a message by ID
POST
/v1/message/search
Search messages
GET
/v1/message/search
Search messages
GET
/v1/stream/{sid}/attachment
Download an attachment.
GET
/v3/health
Checks health status
GET
/v3/health/extended
Checks health status of services and users
POST
/v4/message/import
Import messages from other systems into Symphony.
POST
/v4/message/blast
Post a message to multiple existing streams.
GET
/v1/message/{id}
Get a message by ID
POST
/v1/message/search
Search messages
GET
/v1/message/search
Search messages
GET
/v1/stream/{sid}/attachment
Download an attachment.
Jentic AI Readiness Score
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.
A
Agent API
- AI-Aware (B+)68/100
86
Foundational Compliance67
Developer Experience & Jentic Compatibility45
AI-Readiness & Agent Experience93
Agent Usability100
Security68
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
86
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
95%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
50%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
67
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: BSignals: 4
1%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
74%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
93%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
45
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: DSignals: 4
66%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
61%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
54%
Summary Coverage
Coverage of summaries across operations/tags/info.
93
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
93%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
100
Security
Trust, risk posture, and security compliance.
Grade: A+Signals: 1
100%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
68
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B+Signals: 1
68%
Descriptive Richness
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>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Symphony Agent API by hand means standing up your own agent URL under symphony.com, managing the session and key-manager tokens each call expects, and shaping the message and stream requests yourself. Through Jentic you install once, import the Symphony Agent API from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
The Symphony Agent API carries the message and stream targets in the request body and parameters rather than a single owning resource path, so scope the agent to the operations it needs, such as importing a message or searching messages. You choose that allowed set, so an operation you do not add, like blasting a message to many streams, stays out of reach.
Credential isolation
Your Symphony session and key-manager tokens 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 'check agent health' or 'search messages in a stream', and Jentic returns the matching Symphony operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Agent API through Jentic.
What authentication does the Agent API use?
The Agent API 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 checks health status with the Agent API?
Yes. Use the GET /v3/health endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Agent 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 checks health status through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'checks health status'. Jentic returns the matching Agent API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Agent API have?
The Agent API exposes 56 endpoints covering attachments, audittrail, dlp policies and dictionary management operations.
Can I limit what my agent is allowed to do with the Symphony Agent API?
Yes. Because you run Jentic One yourself, you decide which Symphony Agent API operations the agent may call, and it can use only the ones you add. The API carries its message and stream targets in the request body and parameters rather than a single owning path, so you scope by operation, for example allowing GET /v1/message/search to read messages and GET /v3/health to check status while leaving POST /v4/message/blast out of the allowed set. Any operation you do not add, such as blasting a message to many streams or importing messages from other systems, stays out of the agent's reach.
GET STARTED