For Agents
Programmatically create generator interaction, get all people. Covers 12 operations with apiKey authentication.
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Soul Machines Interactions 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://jentic.com/install.sh?src=apis&api=%2Fapis%2Fsoulmachines.cloud%2Fsoulmachines-cloud" | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fsoulmachines.cloud%2Fsoulmachines-cloud" | 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.
What an agent can do with Soul Machines Interactions API.
Create Generator Interaction
Get All People
Subscribe Trigger
Unsubscribe Trigger
GET STARTED
Use for: I need to generator interaction, I want to all people, Search for interaction tones, Find all org
Not supported: Does not handle communications, crm, or developer tools - use for payments only.
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.
Monitor Soul Machines Interactions API operational status and events
Patterns agents use Soul Machines Interactions API for, with concrete tasks.
★ 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.
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.
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.
Search Jentic for 'create generator interaction', load the operation schema, and execute with Jentic-managed credentials
12 endpoints — the soul machines interactions api lets you create fully customized digital person interactions on demand - programmatically, at scale.
METHOD
PATH
DESCRIPTION
/api/v1/generator
Create Generator Interaction
/api/v1/people
Get All People
/api/v1/tones
Get Interaction Tones
/api/v1/org
Get Org
/api/v1/response_lengths
Get Interaction Response Lengths
/api/v1/triggers/subscribe
Subscribe Trigger
/api/v1/triggers/unsubscribe
Unsubscribe Trigger
/api/v1/triggers/sample_data
Get Trigger Sample Data
/api/v1/generator
Create Generator Interaction
/api/v1/people
Get All People
/api/v1/tones
Get Interaction Tones
/api/v1/org
Get Org
/api/v1/response_lengths
Get Interaction Response Lengths
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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.
Alternatives and complements available in the Jentic catalogue.
Stripe
Alternative payments API
Choose Stripe when you need a different approach to payments operations
Specific to using Soul Machines Interactions API through Jentic.
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.
/api/v1/triggers/subscribe
Subscribe Trigger
/api/v1/triggers/unsubscribe
Unsubscribe Trigger
/api/v1/triggers/sample_data
Get Trigger Sample Data