canonical: https://jentic.com/apis/soulmachines.cloud/soulmachines-cloud

# Soul Machines Interactions API

The Soul Machines Interactions API lets you create fully customized digital person interactions on demand - programmatically, at scale. Instead of pre-configuring static avatars, you define each interaction's context, purpose, personality, and tone in real time, then receive a unique, shareable URL to deliver that personalized experience to your end users. How it works 1. **Make an API request** -. The API exposes 12 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create generator interaction, get all people. Covers 12 operations with apiKey authentication.

## Scope

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

## Capabilities

- Create Generator Interaction
- Get All People
- Subscribe Trigger
- Unsubscribe Trigger
- Monitor Soul Machines Interactions API operational status and events

## Use cases

### Payments Operations

Use the Soul Machines Interactions API to perform payments operations programmatically. The API provides 12 endpoints covering core functionality including create generator interaction, get all people, get interaction tones.

Example prompt: Call POST `/api/v1/generator` to create generator interaction

### Automated Generator Management

Automate generator operations by combining multiple Soul Machines Interactions API endpoints. Agents can get all people and then get interaction tones in a single workflow.

Example prompt: Call GET `/api/v1/people` to get all people, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Soul Machines Interactions 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 'create generator interaction', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v1/generator` | Create Generator Interaction |
| GET | `/api/v1/people` | Get All People |
| GET | `/api/v1/tones` | Get Interaction Tones |
| GET | `/api/v1/org` | Get Org |
| GET | `/api/v1/response_lengths` | Get Interaction Response Lengths |
| POST | `/api/v1/triggers/subscribe` | Subscribe Trigger |
| POST | `/api/v1/triggers/unsubscribe` | Unsubscribe Trigger |
| GET | `/api/v1/triggers/sample_data` | Get Trigger Sample Data |

## Key resources

- **Generator** — Operations for generator
- **Health** — Operations for health
- **Org** — Operations for org
- **People** — Operations for people
- **Response_Lengths** — Operations for response_lengths

## 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:** 56 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 72 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 45 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 33 / 100
- **View full report:** https://jentic.com/apis/soulmachines.cloud/soulmachines-cloud/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 Soul Machines Interactions API by hand means passing its x-api-key header on every call, pointing at the interactions-api.soulmachines.cloud host, and handling retries across its generator and trigger endpoints yourself. Through Jentic you install once, import the Soul Machines Interactions API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** The Soul Machines Interactions API carries its targets in the request body and header rather than resource ids in the URL path, so limit the agent to the operations it needs, such as creating a generator interaction or listing people. You choose the operations it may call, so state-changing ones like subscribing or unsubscribing triggers are not included unless you add them.
- **Credential handling:** Your Soul Machines 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 'create a generator interaction' or 'list available tones', and Jentic returns the matching Soul Machines Interactions API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Soul Machines Interactions API use?

The Soul Machines Interactions 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 create generator interaction with the Soul Machines Interactions API?

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

### What are the rate limits for the Soul Machines Interactions 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 create generator interaction through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create generator interaction'. Jentic returns the matching Soul Machines Interactions API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Soul Machines Interactions API have?

The Soul Machines Interactions API exposes 12 endpoints covering generator, health, org operations.

### Can I limit what my agent is allowed to do with the Soul Machines Interactions API?

Yes. Because you run Jentic One yourself, your own rules decide which Soul Machines operations and credentials the agent may use, so you can allow only read calls like getting all people or interaction tones while withholding anything else. State-changing operations such as creating a generator interaction or subscribing and unsubscribing triggers are excluded unless you add them. Your API key is injected at execution time under those same rules, so the agent can reach only the endpoints you permit.