PL Log inCreate account
Launching in October 2026. Accounts, model catalog, calculator and docs are live. Studio is available in preview; generation is awaiting activation.

AGENTS.md file for agents

All documentation pages

AGENTS.md is a plain text file in the root of your project that AI agents read before they start working. Jantaris serves a ready version at https://jantaris.com/agents.md. Once it is in your repo, the agent knows how to authenticate, how to request an image or video with POST /v1/generate, how to poll a task, how to talk to chat models and how to connect the MCP server. You do not have to explain anything.

What the file contains

  • base URL https://jantaris.com/v1 and the header Authorization: Bearer $JANTARIS_API_KEY,
  • cost rules: reservation before start, failed generation costs 0, codes 402 and 403,
  • the model catalog (GET /v1/models, GET /v1/models/{id}) and the rule "read the schema before sending input",
  • curl examples: image, video with polling, song with lyrics, chat,
  • signed webhooks,
  • MCP setup for Claude Code, Codex CLI and Cursor,
  • an error table and a warning that POST /v1/generate is not idempotent.

Add it to your repo

Open a terminal in the root folder of your project.

macOS and Linux

bash
curl -fsSL https://jantaris.com/agents.md -o AGENTS.md

Already have your own AGENTS.md? Append instead of overwriting:

bash
curl -fsSL https://jantaris.com/agents.md >> AGENTS.md

Windows PowerShell

powershell
Invoke-WebRequest -Uri "https://jantaris.com/agents.md" -OutFile "AGENTS.md"

Append to an existing file:

powershell
Invoke-RestMethod -Uri "https://jantaris.com/agents.md" | Add-Content -Path "AGENTS.md" -Encoding utf8

No terminal

Open https://jantaris.com/agents.md in your browser, select all (Ctrl+A or Cmd+A), copy and paste it into a new AGENTS.md file in your project folder.

Verify

bash
head -5 AGENTS.md
powershell
Get-Content AGENTS.md -TotalCount 5

The first line is # AGENTS.md - Jantaris API. Then ask your agent: "According to AGENTS.md, how do I generate an image with Jantaris?". If it answers with POST /v1/generate and ?wait=60, the file works.

Which tools read it

ToolHow
Codex CLIReads AGENTS.md automatically
CursorReads AGENTS.md in the project root
VS Code (Copilot)Reads AGENTS.md in agent mode
OpenCodeReads AGENTS.md automatically
Claude CodeReads CLAUDE.md. Add the line @AGENTS.md to it and Claude Code includes the file
AiderRun aider --read AGENTS.md
OthersStart the chat with: "Read AGENTS.md and follow it"

For Claude Code, the quickest way:

bash
echo "@AGENTS.md" >> CLAUDE.md
powershell
Add-Content -Path "CLAUDE.md" -Value "@AGENTS.md"

The key stays out of the repo

The file contains no key. The agent reads it from the JANTARIS_API_KEY environment variable, which you set once:

bash
export JANTARIS_API_KEY="sk-jt-..."
powershell
[Environment]::SetEnvironmentVariable("JANTARIS_API_KEY", "sk-jt-...", "User")

Create the key in the dashboard, API keys tab. Give it a Monthly limit - an agent that can generate video should have a hard spending ceiling.

If you keep the key in a .env file, make sure .env is in .gitignore.

Your own rules below

Under the API description add rules for your project, for example:

markdown
## Project rules

- Before any video generation, state the cost (estimated_cost) and wait for my approval.
- Save images in public/img/ as .webp.
- Use nano-banana-pro for images and seedance-2.5 at 720p for video.
- Never generate more than 3 variants at once.

Updating

When we add endpoints or change examples, just download the file again with the command above. If you added your own rules, keep them in a separate section and paste them back after downloading, or move them to a separate file.

Common problems

SymptomFix
The file contains HTML instead of textCheck the URL: https://jantaris.com/agents.md (lowercase)
Agent ignores the fileMake sure it sits in the project root. In Claude Code add @AGENTS.md to CLAUDE.md
Agent gets 401JANTARIS_API_KEY is not set in the terminal you started it from