Home • Explore • Blog • Models • CI
☰



ragit
3rd chunk of `docs/ragithub/openapi.yaml`
3efaa3a82f5b13d119e06dffd6f4fad4296ff3177d81f5620000000100000fa2
         description: first 2 characters of the uid of the image
          schema:
            type: string
      responses:
        '200':
          description: a list of image uids that start with the prefix
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
  /{user}/{repo}/image/{image-uid}:
    get:
      operationId: GetImage
      parameters:
        - name: user
          in: path
          required: true
          description: user id
          schema:
            type: string
        - name: repo
          in: path
          required: true
          description: repository name
          schema:
            type: string
        - name: image-uid
          in: path
          required: true
          description: uid of the image
          schema:
            type: string
      responses:
        '200':
          description: the image
          content:
            image/png:
              schema:
                type: string
                format: binary
  /{user}/{repo}/image-desc/{image-uid}:
    get:
      operationId: GetImageDescription
      parameters:
        - name: user
          in: path
          required: true
          description: user id
          schema:
            type: string
        - name: repo
          in: path
          required: true
          description: repository name
          schema:
            type: string
        - name: image-uid
          in: path
          required: true
          description: uid of the image
          schema:
            type: string
      responses:
        '200':
          description: description of the image
          content:
            application/json:
              schema:
                type: object
                properties:
                  extracted_text:
                    type: string
                  explanation:
                    type: string
  /{user}/{repo}/file-content:
    get:
      description: get a content of a file or a directory
      operationId: GetFileContent
      parameters:
        - name: user
          in: path
          required: true
          description: user id
          schema:
            type: string
        - name: repo
          in: path
          required: true
          description: repository name
          schema:
            type: string
        - name: path
          in: query
          description: path of a file or a directory
          schema:
            type: string
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            format: int32
            default: 100
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            format: int32
            default: 0
      responses:
        '200':
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileDetail'
  /{user}/{repo}/cat-file/{uid}:
    get:
      description: If you want to get a content of a file or a chunk, I recommend you use `/{user}/{repo}/content/{uid}` api instead of this. This api exists for historical reasons.
      operationId: GetCatFile
      parameters:
        - name: user
          in: path
          required: true
          description: user id
          schema:
            type: string
        - name: repo
          in: path
          required: true
          description: repository name
          schema:
            type: string
        - name: uid
          in: path
          required: true
          description: uid of a file or a chunk
          schema:
            type: string
      responses:
        '200':
          description: It's exactly same as running `rag cat-file` with the uid.
          content:
            text/plain:
              schema:
                type: string
  /{user}/{repo}/content/{uid}:
Title: API Endpoints for Image and File Management
Summary
This section of the API documentation describes endpoints for retrieving images, image descriptions, file contents, and cat-file contents, including parameters such as user ID, repository name, image or file UIDs, and query parameters for pagination and filtering, with responses in various formats including JSON, binary, and plain text.