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

# yourang External API

yourang.ai External API for managing AI voice agents, actions, contacts, catalogues, and action history. The API exposes 24 endpoints secured with bearer authentication.

## For AI agents

Programmatically list available actions, execute single action. Covers 24 operations with bearer authentication.

## Scope

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

## Capabilities

- List available actions
- Execute single action
- Batch execution with phone numbers
- Get action execution details
- Monitor yourang External API operational status and events

## Use cases

### CRM Operations

Use the yourang External API to perform crm operations programmatically. The API provides 24 endpoints covering core functionality including list available actions, execute single action, batch execution with phone numbers.

Example prompt: Call GET /actions to list available actions

### Automated Action History Management

Automate action history operations by combining multiple yourang External API endpoints. Agents can execute single action and then batch execution with phone numbers in a single workflow.

Example prompt: Call POST `/actions/{configuration_id}/execute` to execute single action, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call yourang External 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 bearer tokens manually.

Example prompt: Search Jentic for 'list available actions', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/actions` | List available actions |
| POST | `/actions/{configuration_id}/execute` | Execute single action |
| POST | `/actions/{configuration_id}/batch/numbers` | Batch execution with phone numbers |
| POST | `/actions/{configuration_id}/batch/contacts` | Batch execution with contact IDs |
| GET | `/actions/history` | List action execution history |
| GET | `/actions/history/{action_history_id}` | Get action execution details |
| GET | `/actions/batch-history` | List batch executions |
| GET | `/actions/batch-history/{batch_execute_id}` | Get batch execution details |

## Key resources

- **Action History** — Operations related to Action History
- **Actions** — Operations related to Actions
- **Agent Tools** — Operations related to Agent Tools
- **Agents** — Operations related to Agents
- **Catalogues** — Operations related to Catalogues

## 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:** 68 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 78 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 51 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/yourang.ai/yourang/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 yourang External API by hand means sending its yk_ prefixed bearer key on api.yourang.ai, coordinating action and batch executions, and handling retries yourself. Through Jentic you install once, import the yourang External API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The yourang External API puts the configuration id in the URL path (`/actions/{configuration_id}/execute`), so a rule can pin your agent to one action configuration: it can execute that configuration and nothing else. You choose the operations it may call, so batch runs over numbers or contacts are not included unless you add them.
- **Credential handling:** Your yourang 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 'list available actions' or 'execute an action', and Jentic returns the matching yourang External API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the yourang External API use?

The yourang External API uses a Bearer token in the Authorization 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 list available actions with the yourang External API?

Yes. Use the GET /actions endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the yourang External 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 list available actions through Jentic?

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

### How many endpoints does the yourang External API have?

The yourang External API exposes 24 endpoints covering action history, actions, agent tools operations.

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

Yes. Because Jentic One is self-hosted, you set the rules that decide which yourang operations and credentials your agent may use. Since the yourang External API carries the configuration id in the URL path, such as POST `/actions/{configuration_id}/execute`, you can pin the agent to a single action configuration so it executes that one and nothing else. You choose the operations it may call, so batch runs over phone numbers or contact IDs stay off unless you explicitly allow them.