canonical: https://jentic.com/apis/swatle.ai/swatle

# Swatle AI API

Swatle AI-Powered Business Platform API for intelligent automation and analytics. The API exposes 10 endpoints secured with apiKey authentication.

## For AI agents

Programmatically generate report, list reports. Covers 10 operations with apiKey authentication.

## Scope

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

## Capabilities

- Generate Report
- List Reports
- Get Report
- Create Workflow
- Delete Workflow

## Use cases

### Analytics Operations

Use the Swatle AI API to perform analytics operations programmatically. The API provides 10 endpoints covering core functionality including generate report, list reports, get report.

Example prompt: Call POST `/analytics/reports` to generate report

### Automated Analytics Management

Automate analytics operations by combining multiple Swatle AI API endpoints. Agents can list reports and then get report in a single workflow.

Example prompt: Call GET `/analytics/reports` to list reports, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Swatle AI 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 'generate report', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/analytics/reports` | Generate Report |
| GET | `/analytics/reports` | List Reports |
| GET | `/analytics/reports/{reportId}` | Get Report |
| POST | `/automation/workflows` | Create Workflow |
| GET | `/automation/workflows` | List Workflows |
| GET | `/automation/workflows/{workflowId}` | Get Workflow |
| DELETE | `/automation/workflows/{workflowId}` | Delete Workflow |
| POST | `/automation/workflows/{workflowId}/execute` | Execute Workflow |

## Key resources

- **Analytics** — Business analytics operations
- **Automation** — Workflow automation
- **Models** — AI model management

## 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:** 61 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 78 / 100
  - Developer Experience & Jentic Compatibility: 56 / 100
  - AI-Readiness & Agent Experience: 43 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/swatle.ai/swatle/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 the Swatle AI API by hand means passing its X-API-Key header on every call against api.swatle.ai and managing its report, workflow, and model routes yourself. Through Jentic you install once, import the Swatle AI API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Swatle AI API puts each resource id in the URL path (`/analytics/reports/{reportId}`, `/automation/workflows/{workflowId}`), so a rule can pin your agent to one report or workflow: it can read and run that resource and nothing else. You choose the operations it may call, so destructive ones like deleting a workflow are not included unless you add them.
- **Credential handling:** Your Swatle AI 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 'generate an analytics report' or 'execute a workflow', and Jentic returns the matching Swatle AI API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mixpanel** — Alternative analytics API
- **Amplitude** — Alternative analytics API
- **Segment** — Complementary analytics API
- **Pendo** — Complementary analytics API

## FAQ

### What authentication does the Swatle AI API use?

The Swatle AI 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 generate report with the Swatle AI API?

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

### What are the rate limits for the Swatle AI 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 generate report through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'generate report'. Jentic returns the matching Swatle AI API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Swatle AI API have?

The Swatle AI API exposes 10 endpoints covering analytics, automation, models operations.

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

Yes. Jentic One is self-hosted, so your own rules decide which Swatle AI API operations your agent may call and which credentials it may use. Because the API puts each resource id in the URL path, such as `/analytics/reports/{reportId}` and `/automation/workflows/{workflowId}`, you can pin your agent to a single report or workflow and let it read and run only that resource. You also choose the exact operations it may invoke, so a destructive call like DELETE `/automation/workflows/{workflowId}` stays off limits unless you explicitly allow it.