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

# Pixelixe API

The Pixelixe API allows developers to search and manage design documents, automate image generation from templates, and apply filters and processing operations to images over HTTP. The API exposes 4 endpoints secured with apiKey authentication.

## For AI agents

Programmatically test API key, search documents. Covers 4 operations with apiKey authentication.

## Scope

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

## Capabilities

- Test API key
- Search documents
- Generate an image from a template (Image Automation API)
- Apply filters and photo effects

## Use cases

### Media and Content Operations

Use the Pixelixe API to perform media operations programmatically. The API provides 4 endpoints covering core functionality including test API key, search documents, generate an image from a template (image automation API).

Example prompt: Call GET `/api/authentication/v2` to test API key

### Automated Authentication Management

Automate authentication operations by combining multiple Pixelixe API endpoints. Agents can search documents and then generate an image from a template (image automation API) in a single workflow.

Example prompt: Call GET `/api/document/search/v2` to search documents, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Pixelixe 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 'test API key', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/authentication/v2` | Test API key |
| GET | `/api/document/search/v2` | Search documents |
| POST | `/api/graphic/automation/v2` | Generate an image from a template (Image Automation API) |
| GET | `/api/photo/effect/v2` | Apply filters and photo effects |

## Key resources

- **Authentication** — Operations for authentication
- **Document** — Operations for document
- **Graphic** — Operations for graphic
- **Photo** — Operations for photo

## 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:** 67 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 64 / 100
  - AI-Readiness & Agent Experience: 49 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 84 / 100
- **View full report:** https://jentic.com/apis/pixelixe.com/pixelixe/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 Pixelixe by hand means sending its API key in the Authorization header, coordinating the document, graphic, and photo calls, and handling retries yourself. Through Jentic you install once, import Pixelixe from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** You limit the agent to the operations it needs, such as searching documents or running a graphic automation. Because you choose the allowed operations, the photo-effect call stays out of scope unless you add it.
- **Credential handling:** Your Pixelixe API key is stored once, encrypted, by your own Jentic One instance and injected as the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'automate a graphic from a template' or 'search documents', and Jentic returns the matching Pixelixe 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 Pixelixe API use?

The Pixelixe 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 test API key with the Pixelixe API?

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

### What are the rate limits for the Pixelixe 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 test API key through Jentic?

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

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

The Pixelixe API exposes 4 endpoints covering authentication, document, graphic operations.

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

Yes. Because Jentic One is self-hosted, you set the rules that decide which Pixelixe operations and credentials your agent may use. You can allow just the calls it needs, such as searching documents or running a graphic automation, while leaving the photo-effect operation out of scope. Only the operations you enable can run, and your API key stays under your control.