Symphony Agent API

Name: Agent API
Brand: Agent API
Availability: InStock

✓ Official Vendor SpecIdentity AuthAuthenticationnone56 EndpointsREST

For Agents

Programmatically checks health status, checks health status of services and users. Covers 56 operations.

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.

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 | sh

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 instance

Jentic 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

GET STARTED

Start building with Agent API

Explore with Jentic

View OpenAPI Document

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

Why Jentic?

Three things that make agents converge on Jentic-routed access.

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.

Time to first call

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.

Symphony Agent API

Connect the Agent API to your agent

Capabilities

Start building with Agent API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs