ydb-qdrant-tech Requests API

openapi: 3.2.0
info:
  title: Codex Pets Requests API
  version: 1.0.0
  description: 'Browse, preview, upload, and download community-made animated pet packs for Codex. This OpenAPI document describes version 1 of the public agent/developer contract subset: approved registry data, MCP discovery, markdown discovery docs, pricing and terms discovery, and public submission workflows. Existing unversioned URLs are stable v1 endpoints. Additive changes may appear without notice; breaking public-agent contract changes require a new path or a published deprecation notice. Public metric mutation and download redirect routes are intentionally outside this contract.'
  contact:
    name: Codex Pets
    url: https://pets.ydb-qdrant.tech/about
servers:
- url: https://pets.ydb-qdrant.tech
tags:
- name: Requests
  description: Public pet generation request workflow.
paths:
  /api/generation-requests:
    post:
      operationId: createPetGenerationRequest
      tags:
      - Requests
      summary: Create a public Codex pet generation request
      description: Accepts anonymous requests. If an app session is present, the request is associated with the signed-in user.
      security: []
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 128
          pattern: ^[A-Za-z0-9._~-]{1,128}$
        description: Optional retry key for public create operations. Reusing the same key with the same normalized request body returns the first successful 201 response after it completes; while the first request is still processing it returns 409 idempotency_key_in_progress. Reusing the key with a different body returns 409 idempotency_key_conflict. Completed idempotency records are retained for 24 hours.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGenerationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateGenerationRequestForm'
      responses:
        '201':
          description: Successful JSON response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGenerationRequestResponse'
        '400':
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CreateGenerationRequestForm:
      type: object
      required:
      - contactEmail
      - prompt
      properties:
        contactEmail:
          type: string
          format: email
        requesterName:
          type: string
        displayNameHint:
          type: string
        prompt:
          type: string
          maxLength: 2000
        kind:
          type: string
          enum:
          - creature
          - object
          - character
          default: creature
        referenceImage:
          type: string
          format: binary
          description: Optional PNG, JPEG, or WebP reference image up to 5 MB.
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        message:
          type: string
        hint:
          type: string
        field:
          type: string
      required:
      - error
      - code
      - message
      additionalProperties: true
    CreateGenerationRequest:
      type: object
      required:
      - contactEmail
      - prompt
      properties:
        contactEmail:
          type: string
          format: email
        requesterName:
          type:
          - string
          - 'null'
        displayNameHint:
          type:
          - string
          - 'null'
        prompt:
          type: string
          maxLength: 2000
        kind:
          type: string
          enum:
          - creature
          - object
          - character
          default: creature
    CreateGenerationRequestResponse:
      type: object
      required:
      - ok
      - request
      properties:
        ok:
          type: boolean
        request:
          type: object
          required:
          - id
          - status
          - createdAt
          properties:
            id:
              type: string
            status:
              type: string
              enum:
              - pending
            createdAt:
              type: string
              format: date-time
  securitySchemes:
    AppSessionCookie:
      type: apiKey
      in: cookie
      name: codex_pets_session
      description: Optional app-session cookie used by browser account flows. Public read endpoints do not require it.
    ProxyBasic:
      type: http
      scheme: basic
      description: Deployment mode for trusted reverse proxies. Public agent endpoints are designed to be readable without credentials.