canonical: https://jentic.com/apis/sentiyen.com/sentiyen

# Sentiyen API

Sentiyen AI-powered Q&A API for building conversational interfaces. Supports streaming and non-streaming message generation with references and followup questions. The API exposes 3 endpoints secured with apiKey authentication.

## For AI agents

Programmatically send a chat message (non-streaming), generate followup question suggestions. Covers 3 operations with apiKey authentication.

## Scope

Does not handle payments, crm, or developer tools - use for communications only.

## Capabilities

- Send a chat message (non-streaming)
- Generate followup question suggestions
- Record user feedback for a message
- Query and filter Sentiyen API records by parameters
- Monitor Sentiyen API operational status and events

## Use cases

### Communications Operations

Use the Sentiyen API to perform communications operations programmatically. The API provides 3 endpoints covering core functionality including send a chat message (non-streaming), generate followup question suggestions, record user feedback for a message.

Example prompt: Call POST `/chat/message` to send a chat message (non-streaming)

### Automated Messaging Management

Automate messaging operations by combining multiple Sentiyen API endpoints. Agents can generate followup question suggestions and then record user feedback for a message in a single workflow.

Example prompt: Call POST `/chat/message/followup-suggestions` to generate followup question suggestions, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Sentiyen 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.

Example prompt: Search Jentic for 'send a chat message (non-streaming)', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/chat/message` | Send a chat message (non-streaming) |
| POST | `/chat/message/followup-suggestions` | Generate followup question suggestions |
| POST | `/chat/message/feedback` | Record user feedback for a message |

## Key resources

- **Messaging** — Operations related to Messaging

## AI readiness

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.

- **Score:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 49 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 58 / 100
- **View full report:** https://jentic.com/apis/sentiyen.com/sentiyen/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Sentiyen by hand means setting the X-API-Key header on every chat request and handling its message and feedback calls yourself. Through Jentic you install once, import Sentiyen from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Sentiyen carries the chat target in the request body, not the URL path, so limit the agent to the operations it needs, such as sending a chat message or requesting follow-up suggestions. You choose the operations it may call, so feedback submission is not included unless you add it.
- **Credential handling:** Your Sentiyen API key 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.
- **Discovery method:** Agents search Jentic by intent such as 'send a chat message' or 'get follow-up suggestions', and Jentic returns the matching Sentiyen operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the Sentiyen API use?

The Sentiyen API uses an API key passed in the `X-API-Key` 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 send a chat message (non-streaming) with the Sentiyen API?

Yes. Use the POST `/chat/message` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Sentiyen 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 send a chat message (non-streaming) through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'send a chat message (non-streaming)'. Jentic returns the matching Sentiyen API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Sentiyen API have?

The Sentiyen API exposes 3 endpoints covering messaging operations.

### Can I limit what my agent is allowed to do with the Sentiyen API?

Yes. Because you run Jentic One yourself, your own rules decide which Sentiyen operations and credentials the agent may use. Since Sentiyen carries the chat target in the request body rather than the URL path, you scope access at the operation level, allowing only what the agent needs such as sending a chat message or requesting follow-up suggestions. You choose the operations it may call, so feedback submission stays out of reach unless you explicitly add it.