Symphony Agent API
✓ Official Vendor SpecIdentity 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://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | 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.
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
Agent API none credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw secrets never enter the agent context.
Intent-based discovery
Agents search by intent (e.g., 'checks health status') and Jentic returns the matching Agent API operation with its input schema, so the agent can call the right endpoint without browsing docs.
Time to first call
Direct Agent API integration: 1-3 days for auth handling, response parsing, and error cases. Through Jentic: under 1 hour — search, load schema, execute.
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 the MAXsystem vault 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 at https://app.jentic.com/sign-up, 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.
GET STARTED