api-ref-ffs-styleguide

A checklist for reviewing Adobe Firefly Services API references, which document Adobe's web APIs. It covers URL patterns, asynchronous jobs, status responses, errors, and JSON naming.

In plain words
What is it for?
Use it with api-eval to audit stateless Firefly Services APIs, especially POST operations that start jobs and GET operations that return results or status.
Why use it?
It helps reviewers check Firefly API documentation against the team's required style and behavior, without applying those checks during repairs.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/adobedocs/ff-services-docs/api-ref-ffs-styleguide
Clone the repo
git clone --depth 1 https://github.com/AdobeDocs/ff-services-docs

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 597 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00597
Opus 5 $0.00000 $0.00298
Sonnet 5 $0.00000 $0.00119
Haiku 4.5 $0.00000 $0.00060

Measured 2d ago against content hash 12a0787be9cc, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-ref-ffs-styleguide scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/api-ref-ffs-styleguide.mdc · 68 lines

How it starts

The opening of the file, as written. The whole thing — 68 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Firefly Services API Style Guide (eval only)

Wiki: Firefly Services API Style Guide

Use with /api-eval only. /api-fix does not apply these unless Redocly flags them.

Offline checklist: .cursor/skills/api-eval/ffs-styleguide-checklist.md

Scope

Stateless Firefly Services RPC APIs. POST → async; GET (collections, status) → sync.

HTTP and URLs

  • POST operations: async 202 pattern.
  • URL shape: https://{subdomain}.adobe.io/v{version}/{operation-name}.
  • POST paths: verb-led, hyphenated (e.g. /v2/generate-object-composite).
  • GET collections: plural nouns.

Async 202 response

Required: jobId, statusUrl. Optional: cancelUrl. URLs: …/v{version}/status/{jobId}.

Status polling (GET)

  • status: not_started, running, succeeded, failed, partially_succeeded, canceled.
  • jobId on all status responses.
  • Failed: error_code or errors[] per Error Codes wiki.

Errors

  • 4xx/5xx and job failures: error_code required; message optional.
  • Codes from Error Codes wiki.

JSON conventions

  • Property names: camelCase (except error_code).
  • American English spellings.
  • Suffixes: *Date, *MediaType, *LocaleCode, *Folder; plural names for arrays.
  • Date-times: ISO 8601 with Z; locales: en-US.
  • Media types: enum in OpenAPI spec.
  • Omit null properties in responses (no anyOf with null for optional fields).

Resource objects

Only: url, uploadId, or ACPC-related properties; optional storageType for Azure/Dropbox output URLs.

source / destination

Recommended wrapper pattern for binary inputs/outputs with peer metadata.

POST → async (Jan 2026)

Product POST endpoints should use the async calling pattern.

Severity

  • error — invalid OpenAPI or lint failure
  • high — style guide contract violation
  • medium — doc/copy vs modular rules
  • low — suggestion

Read the full file on GitHub · 68 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 68 lines · 0 tokens per session scan A 12a0787be9cc

Subscribe to this mod's changes

api-ref-ffs-styleguide is a cursor rule published in the GitHub repository AdobeDocs/ff-services-docs (4 stars, last pushed 2mo ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 597 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.