canonical: https://jentic.com/apis/yepcode.io/yepcode

# YepCode REST API

YepCode REST API - OpenAPI Specification. The API exposes 54 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically resume scheduled process, pause scheduled process. Covers 54 operations with oauth2 authentication.

## Scope

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

## Capabilities

- Resume scheduled process
- Pause scheduled process
- Kill execution
- Create variable
- Get variables
- Upload an object

## Use cases

### Developer Tools Operations

Use the YepCode REST API to perform developer tools operations programmatically. The API provides 54 endpoints covering core functionality including resume scheduled process, pause scheduled process, kill execution.

Example prompt: Call PUT `/schedules/{id}/resume` to resume scheduled process

### Automated Auth Management

Automate auth operations by combining multiple YepCode REST API endpoints. Agents can pause scheduled process and then kill execution in a single workflow.

Example prompt: Call PUT `/schedules/{id}/pause` to pause scheduled process, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call YepCode REST 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 oauth2 tokens manually.

Example prompt: Search Jentic for 'resume scheduled process', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| PUT | `/schedules/{id}/resume` | Resume scheduled process |
| PUT | `/schedules/{id}/pause` | Pause scheduled process |
| PUT | `/executions/{id}/kill` | Kill execution |
| POST | `/variables` | Create variable |
| GET | `/variables` | Get variables |
| POST | `/storage/objects` | Upload an object |
| GET | `/storage/objects` | Get objects |
| POST | `/processes` | Create a process |

## Key resources

- **Auth** — Operations related to Auth
- **Executions** — Operations related to Executions
- **Modules** — Operations related to Modules
- **Processes** — Operations related to Processes
- **Schedules** — Operations related to Schedules

## 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: 59 / 100
  - Developer Experience & Jentic Compatibility: 70 / 100
  - AI-Readiness & Agent Experience: 53 / 100
  - Agent Usability: 93 / 100
  - Security: 85 / 100
  - AI Discoverability: 77 / 100
- **View full report:** https://jentic.com/apis/yepcode.io/yepcode/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 YepCode by hand means running its OAuth2 client-credentials flow against the YepCode realm, substituting your team id into the cloud.yepcode.io host, and handling token refresh and retries yourself. Through Jentic you install once, import YepCode from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** YepCode puts the schedule and execution ids in the URL path (`/schedules/{id}`, `/executions/{id}`), so a rule can pin your agent to one schedule or execution: it can pause or resume that schedule and nothing else. You choose the operations it may call, so disruptive ones like killing an execution are not included unless you add them.
- **Credential handling:** Your YepCode credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'resume a scheduled process' or 'create a variable', and Jentic returns the matching YepCode operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the YepCode REST API use?

The YepCode REST API uses OAuth 2.0 for authorization. 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 resume scheduled process with the YepCode REST API?

Yes. Use the PUT `/schedules/{id}/resume` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the YepCode REST 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 resume scheduled process through Jentic?

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

### How many endpoints does the YepCode REST API have?

The YepCode REST API exposes 54 endpoints covering auth, executions, modules operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which YepCode operations and credentials the agent may use. Because YepCode carries the schedule and execution ids in the URL path (`/schedules/{id}`, `/executions/{id}`), you can pin the agent to a single schedule or execution, letting it pause or resume that one and nothing else. You also choose the exact operations it may call, so disruptive ones like killing an execution are excluded unless you explicitly allow them.