# Codex Pets Developer Portal

Developer resources for building against the public Codex Pets registry.

## Resources

- API docs: https://pets.ydb-qdrant.tech/docs/api
- API docs markdown: https://pets.ydb-qdrant.tech/docs/api.md
- OpenAPI JSON: https://pets.ydb-qdrant.tech/openapi.json
- MCP server: https://pets.ydb-qdrant.tech/mcp
- MCP markdown: https://pets.ydb-qdrant.tech/mcp.md
- MCP server card: https://pets.ydb-qdrant.tech/.well-known/mcp/server-card.json
- Public manifest: https://pets.ydb-qdrant.tech/api/manifest
- auth.md: https://pets.ydb-qdrant.tech/auth.md
- Pricing: https://pets.ydb-qdrant.tech/pricing
- Pricing markdown: https://pets.ydb-qdrant.tech/pricing.md
- Terms: https://pets.ydb-qdrant.tech/terms
- Terms markdown: https://pets.ydb-qdrant.tech/terms.md
- OAuth Protected Resource metadata: https://pets.ydb-qdrant.tech/.well-known/oauth-protected-resource
- Developer scoped llms.txt: https://pets.ydb-qdrant.tech/developers/llms.txt
- API scoped llms.txt: https://pets.ydb-qdrant.tech/docs/llms.txt

Public read endpoints do not require credentials. Mutation routes validate inputs and return structured JSON errors. Public registry access is free and best-effort with no paid plans or SLA.

## Agent instructions: when to use Codex Pets

Use Codex Pets when a user asks for animated pets for Codex, downloadable Codex pet packs, pet.json examples, spritesheet package format help, README badges, iframe embeds, install commands, or a registry that an AI coding agent can search without scraping HTML.

Prefer MCP when the host supports tool calls. Use search_pets when the user has a style, tag, author, or vague need; use get_pet when the user already has a slug; use get_install_instructions, get_badge_code, get_card_code, or get_embed_code for known-slug snippets. Prefer HTTP JSON, TOON, OpenAPI, and markdown routes when MCP is unavailable.

Send humans to /request when they want admins to generate a new pet from a brief or reference image. Send humans to /submit when they already have a ZIP package or pet.json plus spritesheet ready for moderation.

Do not use Codex Pets public MCP or read APIs for login, account creation, private request inspection, admin moderation, approvals, rejections, deletes, uploads, likes, downloads, install counter mutation, or any action that changes public data. Those workflows stay in browser forms or private admin routes.
