Codex Pets
API docs

Codex Pets API docs

Public agent/developer contract endpoints for approved pet discovery, install instructions, share snippets, MCP tools, pet generation requests, and moderated pet submissions.

Public endpoints

Examples

curl -s https://pets.ydb-qdrant.tech/api/manifest
curl -s "https://pets.ydb-qdrant.tech/api/pets?q=space&kind=creature"
curl -s https://pets.ydb-qdrant.tech/api/pets/{slug}/install
codex mcp add codexPets --url https://pets.ydb-qdrant.tech/mcp

Authentication

Public read endpoints are unauthenticated. AppSessionCookie and ProxyBasic are documented in the OpenAPI security schemes for browser account flows and trusted proxy deployments. OAuth 2.0 and webhooks are not currently available. Public metric mutation and download redirect routes are outside this OpenAPI contract.

Idempotency

POST /api/generation-requests and POST /api/submissions/register accept an optional Idempotency-Key header for safe retries. Reusing the same key with the same normalized request body returns the first successful 201 response. Reusing it with a different body returns 409 idempotency_key_conflict. Completed idempotency records are kept for 24 hours; after that retention window a key can be processed as a new request.

Versioning and deprecation

Current unversioned public endpoints are stable v1. Additive response fields and new routes may be added without notice. Breaking public-agent contract changes require a new path or a published deprecation notice.

Agent discovery