canonical: https://jentic.com/apis/spectra.fm/spectra-fm

# spectra.fm API

Async export API for spectra.fm. spectra.fm is an AI-powered visual system that turns intent into consistent, production-ready visuals. All endpoints are under /v1. Use objectKey + downloadUrl to retrieve export artifacts. The API exposes 17 endpoints secured with apiKey authentication.

## For AI agents

Programmatically validate API key, list projects. Covers 17 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Validate API key
- List projects
- Get a project
- Query and filter spectra.fm API records by parameters
- Monitor spectra.fm API operational status and events

## Use cases

### E-Commerce Operations

Use the spectra.fm API to perform e commerce operations programmatically. The API provides 17 endpoints covering core functionality including validate API key, list projects, get a project.

Example prompt: Call GET `/v1/whoami` to validate API key

### Automated Auth Management

Automate auth operations by combining multiple spectra.fm API endpoints. Agents can list projects and then get a project in a single workflow.

Example prompt: Call GET `/v1/projects` to list projects, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call spectra.fm 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 |
| --- | --- | --- |
| GET | `/v1/whoami` | Validate API key |
| GET | `/v1/projects` | List projects |
| GET | `/v1/projects/{projectId}` | Get a project |
| GET | `/v1/projects/{projectId}/layout` | Get project layout |
| GET | `/v1/projects/{projectId}/template` | Get project HTML template |
| GET | `/v1/projects/{projectId}/assets` | List project assets |
| GET | `/v1/projects/{projectId}/assets/{assetId}/content` | Get asset content |
| GET | `/v1/projects/{projectId}/locales` | List project locales |

## Key resources

- **Auth** — Authentication and API key validation
- **Projects** — Project management
- **Project Details** — Project layout, templates, assets, locales, themes, and content variables
- **History** — Project version history and snapshots
- **Exports** — Export jobs and artifact management

## 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: 79 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 76 / 100
- **View full report:** https://jentic.com/apis/spectra.fm/spectra-fm/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 spectra.fm by hand means sending your key in the X-API-Key header and routing across projects, layouts, assets, locales, and exports yourself. Through Jentic you install once, import the spectra.fm API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** spectra.fm puts the project id in the URL path (`/v1/projects/{projectId}/...`), so a rule can pin your agent to one project: it reads that project's layout, assets, and locales and nothing else. You choose the operations it may call, so it only reads or exports the project data you allow.
- **Credential handling:** Your spectra.fm 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 projects' or 'download a project export', and Jentic returns the matching spectra.fm operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the spectra.fm API use?

The spectra.fm API uses an API key passed in the `X-API-Key` 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 validate API key with the spectra.fm API?

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

### What are the rate limits for the spectra.fm 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 spectra.fm API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the spectra.fm API have?

The spectra.fm API exposes 17 endpoints covering auth, projects, project details operations.

### Can I limit what my agent is allowed to do with the spectra.fm API?

Yes. Because you run Jentic One yourself, your own rules decide which spectra.fm operations and credentials the agent may use. Since spectra.fm puts the project id in the URL path (`/v1/projects/{projectId}/...`), a rule can pin the agent to a single project, letting it read only that project's layout, assets, and locales. You also choose the exact operations it may call, so it can be restricted to read-only project access or allowed to run exports, and nothing beyond what you permit.