Akave Buckets API

openapi: 3.2.0
info:
  title: Akavelink Buckets API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 11 operation(s) read from 4 public documentation page(s) (each operation names its page in x-source).'
  x-evidence-tiers:
    code-example: 11
    documentation: 0
    pages-with-code: 4
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.akave.xyz/js-docker-example-code
  - https://docs.akave.xyz/akave-o3/authentication-and-access/bucket-policies-and-acls
  - https://docs.akave.xyz/solutions-and-integrations/duckdb
  - https://docs.akave.xyz/solutions-and-integrations/rclone
servers:
- url: http://{host}
  description: Self-hosted Akavelink container (README example maps port 8000)
  variables:
    host:
      default: localhost:8000
tags:
- name: Buckets
paths:
  /buckets:
    get:
      operationId: get_buckets
      tags:
      - Buckets
      summary: GET /buckets
      x-source: https://docs.akave.xyz/js-docker-example-code
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBucketsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET http://localhost:8000/buckets \n 3. View Bucket Details \n Retrieve details of a specific bucket. \n JavaScript Example: \n apiRequest ( 'GET' , '/buckets/myBucket' ); "
      parameters: []
    post:
      operationId: post_buckets
      tags:
      - Buckets
      summary: POST /buckets
      x-source: https://docs.akave.xyz/js-docker-example-code
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBucketsRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostBucketsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST http://localhost:8000/buckets -H \"Content-Type: application/json\" -d '{\"bucketName\": \"myBucket\"}' \n 2. List Buckets \n Retrieve all existing buckets. \n JavaScript Example: \n apiRequest ( 'GET' , '/buckets' ); "
      parameters: []
  /buckets/{bucketName}:
    delete:
      operationId: delete_buckets_myBucket
      tags:
      - Buckets
      summary: DELETE /buckets/myBucket
      x-source: https://docs.akave.xyz/js-docker-example-code
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteBucketsMybucketResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X DELETE http://localhost:8000/buckets/myBucket \n File Operations \n 1. List Files in a Bucket \n Retrieve a list of files within a bucket. \n JavaScript Example: \n apiRequest ( 'GET' , '/buckets/myBucket/files' ); "
      parameters:
      - name: bucketName
        in: path
        required: true
        schema:
          type: string
    get:
      operationId: get_buckets_myBucket
      tags:
      - Buckets
      summary: GET /buckets/myBucket
      x-source: https://docs.akave.xyz/js-docker-example-code
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBucketsMybucketResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET http://localhost:8000/buckets/myBucket \n 4. Delete a Bucket \n Delete a specific bucket. \n JavaScript Example: \n apiRequest ( 'DELETE' , '/buckets/myBucket' ); "
      parameters:
      - name: bucketName
        in: path
        required: true
        schema:
          type: string
  /buckets/{bucketName}/files:
    get:
      operationId: get_buckets_myBucket_files
      tags:
      - Buckets
      summary: GET /buckets/myBucket/files
      x-source: https://docs.akave.xyz/js-docker-example-code
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBucketsMybucketFilesResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET http://localhost:8000/buckets/myBucket/files \n 2. Get File Info \n Fetch metadata about a specific file. \n JavaScript Example: \n apiRequest ( 'GET' , '/buckets/myBucket/files/myFile.txt' ); "
      parameters:
      - name: bucketName
        in: path
        required: true
        schema:
          type: string
    post:
      operationId: post_buckets_myBucket_files
      tags:
      - Buckets
      summary: POST /buckets/myBucket/files
      x-source: https://docs.akave.xyz/js-docker-example-code
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostBucketsMybucketFilesResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST http://localhost:8000/buckets/myBucket/files -F file = @/path/to/file.txt \n 4. Download a File \n Download a file from a bucket. \n JavaScript Example: \n async function downloadFile ( bucketName , fileName , outputDir ) { \n const fs = require ( 'fs' ); \n try { \n const response = await axios . get ( ` ${ API_BASE_URL } /buckets/ ${ bucketName } /files/ ${ fileName } /download` , { \n resp"
      parameters:
      - name: bucketName
        in: path
        required: true
        schema:
          type: string
  /buckets/{bucketName}/files/{fileName}:
    get:
      operationId: get_buckets_myBucket_files_myFile_txt
      tags:
      - Buckets
      summary: GET /buckets/myBucket/files/myFile.txt
      x-source: https://docs.akave.xyz/js-docker-example-code
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBucketsMybucketFilesMyfileTxtResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET http://localhost:8000/buckets/myBucket/files/myFile.txt \n 3. Upload a File \n Upload a file to a bucket. \n ℹ️ \n The maximum file size for upload is 5GB. For larger files please use Multipart Uploads with the Akave O3 API \n JavaScript Example (using FormData): \n const FormData = require ( 'form-data' ); \n const fs = require ( 'fs' ); \n async function uploadFile ( bucketName , filePath ) "
      parameters:
      - name: bucketName
        in: path
        required: true
        schema:
          type: string
      - name: fileName
        in: path
        required: true
        schema:
          type: string
  /buckets/{bucketName}/files/{fileName}/download:
    get:
      operationId: get_buckets_myBucket_files_myFile_txt_download
      tags:
      - Buckets
      summary: GET /buckets/myBucket/files/myFile.txt/download
      x-source: https://docs.akave.xyz/js-docker-example-code
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBucketsMybucketFilesMyfileTxtDownloadResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET http://localhost:8000/buckets/myBucket/files/myFile.txt/download -o myFile.txt \n Output file extension should be the same as the requested file. \n Error Handling \n All endpoints return errors in the following format: \n { \n \"success\" : false , \n \"error\" : \"error message\" \n } \n Ensure you handle these responses in your code to capture and process errors effectively. \n Last updated on Apr"
      parameters:
      - name: bucketName
        in: path
        required: true
        schema:
          type: string
      - name: fileName
        in: path
        required: true
        schema:
          type: string
components:
  schemas:
    DeleteBucketsMybucketResponse:
      type: object
      properties:
        success:
          type: boolean
        error:
          type: string
    GetBucketsMybucketFilesMyfileTxtDownloadResponse:
      type: object
      properties:
        success:
          type: boolean
        error:
          type: string
    GetBucketsResponse:
      type: object
      properties:
        success:
          type: boolean
        error:
          type: string
    PostBucketsResponse:
      type: object
      properties:
        success:
          type: boolean
        error:
          type: string
    PostBucketsRequest:
      type: object
      properties:
        bucketName:
          type: string
    GetBucketsMybucketFilesResponse:
      type: object
      properties:
        success:
          type: boolean
        error:
          type: string
    PostBucketsMybucketFilesResponse:
      type: object
      properties:
        success:
          type: boolean
        error:
          type: string
    GetBucketsMybucketResponse:
      type: object
      properties:
        success:
          type: boolean
        error:
          type: string
    GetBucketsMybucketFilesMyfileTxtResponse:
      type: object
      properties:
        success:
          type: boolean
        error:
          type: string