canonical: https://jentic.com/apis/videnly.com/videnly

# Videnly API

API for managing video generation, queue, and user account details. The API exposes 6 endpoints secured with apiKey authentication.

## For AI agents

Programmatically retrieve all videos, add video generation request to the queue. Covers 6 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for media and content only.

## Capabilities

- Retrieve All Videos
- Add video generation request to the queue
- Get progress of a video generation request
- Clear a specific queue item
- Monitor Videnly API operational status and events

## Use cases

### Media and Content Operations

Use the Videnly API to perform media operations programmatically. The API provides 6 endpoints covering core functionality including retrieve all videos, add video generation request to the queue, get progress of a video generation request.

Example prompt: Call GET `/v1/videos` to retrieve all videos

### Automated Projects Management

Automate projects operations by combining multiple Videnly API endpoints. Agents can add video generation request to the queue and then get progress of a video generation request in a single workflow.

Example prompt: Call POST `/v1/queue/add` to add video generation request to the queue, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Videnly 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 'retrieve all videos', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/videos` | Retrieve All Videos |
| POST | `/v1/queue/add` | Add video generation request to the queue |
| GET | `/v1/queue/progress/{queueId}` | Get progress of a video generation request |
| POST | `/v1/queue/clear` | Clear a specific queue item |
| GET | `/v1/user/account` | Retrieve account details |
| GET | `/v1/projects` | Retrieve all projects |

## Key resources

- **Projects** — Operations for projects
- **Queue** — Operations for queue
- **User** — Operations for user
- **Videos** — Operations for videos

## 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:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 70 / 100
  - AI-Readiness & Agent Experience: 41 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/videnly.com/videnly/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 Videnly API by hand means formatting its apiKey as a Bearer value in the Authorization header and polling its render queue for progress yourself. Through Jentic you install once, import the Videnly API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Videnly puts the queue id in the URL path (`/v1/queue/progress/{queueId}`), so a rule can pin the agent to reading progress for a given job. You choose the operations it may call, so a state-changing one like clearing the queue is not included unless you add it.
- **Credential handling:** Your Videnly 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 'list my rendered videos' or 'check render queue progress', and Jentic returns the matching Videnly operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Cloudinary** — Alternative media API
- **Mux** — Alternative media API

## FAQ

### What authentication does the Videnly API use?

The Videnly API uses an API key passed 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 retrieve all videos with the Videnly API?

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

### What are the rate limits for the Videnly 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 retrieve all videos through Jentic?

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

### How many endpoints does the Videnly API have?

The Videnly API exposes 6 endpoints covering projects, queue, user operations.

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

Yes. Because Jentic One is self-hosted, your own rules decide which Videnly operations and credentials the agent may use, so you can grant read-only calls like GET `/v1/videos` and GET `/v1/queue/progress/{queueId}` while withholding state-changing ones. Since the queue id sits in the URL path, a rule can pin the agent to checking progress for a specific render job. A destructive operation such as POST `/v1/queue/clear` stays unavailable unless you explicitly add it.
