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

# StatePIXEL API

StatePIXEL API for controlling physical pixel status indicators. Set colors and durations for hardware status pixels. The API exposes 3 endpoints secured with apiKey authentication.

## For AI agents

Programmatically validate API key, set pixel status color. Covers 3 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for iot and hardware only.

## Capabilities

- Validate API key
- Set pixel status color
- Trigger pixel via webhook
- Query and filter StatePIXEL API records by parameters
- Monitor StatePIXEL API operational status and events

## Use cases

### IoT and Hardware Operations

Use the StatePIXEL API to perform iot operations programmatically. The API provides 3 endpoints covering core functionality including validate API key, set pixel status color, trigger pixel via webhook.

Example prompt: Call POST /validate_key to validate API key

### Automated Authentication Management

Automate authentication operations by combining multiple StatePIXEL API endpoints. Agents can set pixel status color and then trigger pixel via webhook in a single workflow.

Example prompt: Call POST /action to set pixel status color, then verify the result

### AI Agent Integration via Jentic

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/validate_key` | Validate API key |
| POST | `/action` | Set pixel status color |
| GET | `/webhook/{pixel_api_key}` | Trigger pixel via webhook |

## Key resources

- **Authentication** — Operations related to Authentication
- **Pixel** — Operations related to Pixel
- **Webhook** — Operations related to Webhook

## Why Jentic

- **Setup:** Wiring the StatePIXEL API by hand means passing its api_key as a query parameter, mapping the validate, action and webhook calls, and handling the device responses yourself. Through Jentic you install once, import the StatePIXEL API 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 validating a key or triggering an action, so it only does the work you intend and nothing more. Because the action target travels in the request body, scope the agent by operation rather than by a single device.
- **Credential handling:** Your StatePIXEL 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 'validate an API key' or 'trigger a pixel action', and Jentic returns the matching StatePIXEL API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Particle** — Alternative iot API
- **Stripe** — Complementary API for broader integration workflows
- **Twilio** — Complementary API for broader integration workflows

## FAQ

### What authentication does the StatePIXEL API use?

The StatePIXEL API uses an API key passed in the `api_key` query. 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 validate API key with the StatePIXEL API?

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

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

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

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

The StatePIXEL API exposes 3 endpoints covering authentication, pixel, webhook operations.

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

Yes. Because Jentic One is self-hosted, you set the rules on your own instance that decide which StatePIXEL API operations and credentials your agent may use. You can allow only the calls you intend, such as POST /validate_key to check a key, while withholding POST /action or the GET /webhook trigger. Since the action target travels in the request body, you scope the agent by operation rather than by a single device, so it does exactly the work you permit and nothing more.