AI-ready docs

For Agents

NiftyImages v2 is designed for humans, generated clients, CLIs, MCP tools, and LLM-powered development loops. Use these resources when you want an agent to understand the API quickly and call it safely.

Agent operating rules

These docs are written so an agent harness can plan safely before it has credentials, then ask for what it needs before making live calls.

  • If the user asks the agent to call the API and no API key is available, ask for a NiftyImages API key before making /v2 requests.
  • Never invent, guess, log, or expose an API key. Treat it as a secret.
  • Use Authorization: Bearer {apiKey} for authenticated API calls.
  • If the user only asks for planning, code generation, or explanation, use the docs and OpenAPI without asking for an API key.
  • Use OpenAPI for exact request and response schemas before writing integration code.
  • Preserve returned ids and tokens exactly as returned, including storeId, conversationId, timerFrameId, cursor tokens, preview URLs, and thumbnail URLs.
  • Ask a clarifying question before destructive writes when user intent is ambiguous.

Start with the compact context

Use llms.txt when an agent needs a short map of the API, auth model, primary docs, OpenAPI spec, and MCP endpoint.

https://dev.niftyimages.com/llms.txt

Load the full Markdown bundle

Use llms-full.txt when an agent needs more context before planning or writing code. It links to guides, workflow packs, OpenAPI, and MCP resources.

https://dev.niftyimages.com/llms-full.txt

Use Markdown guide pages

Every authored guide has a Markdown counterpart. In the docs UI, use View as Markdown to inspect it directly or Copy for LLM to place the Markdown on your clipboard.

https://dev.niftyimages.com/docs/quickstart.md
https://dev.niftyimages.com/docs/timer-frames.md
https://dev.niftyimages.com/docs/stores.md

Use OpenAPI for exact schemas

The generated OpenAPI document remains the source of truth for operations, request bodies, response shapes, and generated SDKs.

https://dev.niftyimages.com/openapi/v1.json

Use Store MCP for agent tool calls

The human-friendly guide is Connect with AI. Hosted MCP is Data Store CRUD only at /store_mcp (access, list, create/update/delete store, query, get, upsert, patch by record id, CSV import, delete records). Send Authorization: Bearer with a key from the NiftyImages UI (prefer a Store API Key). See connect-mcp.md. Full REST /v2 remains available for images, timers, and other surfaces. 

https://dev.niftyimages.com/store_mcp

Workflow packs

Workflow packs are concise playbooks that tell an agent which calls to make, which ids to retain, and how to recover from common failures.

Agent skills

Use these SKILL.md files when a harness supports reusable skill instructions.