Goodeye Images API

openapi: 3.2.0
info:
  title: Goodeye Images API
  version: 0.1.0
servers:
- url: /v1
tags:
- name: Images
paths:
  /images:
    post:
      tags:
      - Images
      summary: Upload Image
      description: 'Upload an image and return the hosted image record.


        The file must be a PNG, JPEG, WebP, or GIF. Accepted visibility values

        are ``public`` and ``private`` (default ``private``).'
      operationId: upload_image_images_post
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_image_images_post'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Upload Image Images Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Images
      summary: List Images Route
      description: List hosted images owned by the caller, with optional filters.
      operationId: list_images_route_images_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      - name: source
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Source
      - name: visibility
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Visibility
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response List Images Route Images Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /images/{image_id}:
    get:
      tags:
      - Images
      summary: Get Image Route
      description: Fetch a hosted image by id. Caller must own it.
      operationId: get_image_route_images__image_id__get
      parameters:
      - name: image_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Image Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Image Route Images  Image Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Images
      summary: Update Image Route
      description: 'Update visibility, TTL, or the private view link of a hosted image.


        Caller must own it.


        ``ttl_seconds`` and ``permanent`` are mutually exclusive: providing both

        returns a validation error. ``permanent=true`` clears the expiry so the

        image lives indefinitely. ``ttl_seconds`` sets a new expiry relative to now.

        Omitting both leaves the current expiry unchanged.


        ``rotate_view_secret=true`` issues a fresh private view link and invalidates

        every link shared earlier for this image (un-share). For a private image the

        returned ``url`` is the current view link.'
      operationId: update_image_route_images__image_id__patch
      parameters:
      - name: image_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Image Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/_UpdateImageBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Update Image Route Images  Image Id  Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Images
      summary: Delete Image Route
      description: Hard-delete a hosted image. Caller must own it.
      operationId: delete_image_route_images__image_id__delete
      parameters:
      - name: image_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Image Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Body_upload_image_images_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
        visibility:
          type: string
          title: Visibility
          default: private
        ttl_seconds:
          anyOf:
          - type: integer
            exclusiveMinimum: 0.0
          - type: 'null'
          title: Ttl Seconds
      type: object
      required:
      - file
      title: Body_upload_image_images_post
    _UpdateImageBody:
      properties:
        visibility:
          anyOf:
          - type: string
          - type: 'null'
          title: Visibility
        ttl_seconds:
          anyOf:
          - type: integer
            exclusiveMinimum: 0.0
          - type: 'null'
          title: Ttl Seconds
        permanent:
          type: boolean
          title: Permanent
          default: false
        rotate_view_secret:
          type: boolean
          title: Rotate View Secret
          default: false
      type: object
      title: _UpdateImageBody
      description: Request body for PATCH /images/{image_id}.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError