Autonomys Auto Drive Download Gateway API

openapi: 3.2.0
info:
  title: Auto Drive APIs Auto Drive Auto Drive Download Gateway API
  version: 1.1.0
  description: 'Auto-Drive consists of multiple APIs that are used to interact with the Auto-Drive platform.


    ## Authentication


    All requests to the Auto-Drive APIs require authentication. The following authentication methods are supported:


    - API Key

    - JWT Token (rarely used)


    ## How to use an API key?


    The API key is a string that is used to authenticate requests to the Auto-Drive APIs, you can create one in the [Auto-Drive Dashboard](https://ai3.storage).


    To use an API key, include it in the Authorization header with the Bearer prefix:


    ```

    Authorization: Bearer your-api-key

    X-Auth-Provider: apikey

    ```


    API keys should be kept secure and not shared with unauthorized parties.


    ## Purchasing Storage Credits (Pay with AI3)


    Third-party applications can purchase storage credits programmatically using the Intents API. The flow is:


    1. **Create an account** — Register at [ai3.storage](https://ai3.storage) via Google OAuth

    2. **Generate an API key** — From the dashboard, create an API key

    3. **Get contract info** — `GET /intents/contract` returns the contract address, chain ID, and ABI

    4. **Check current price** — `GET /intents/price` returns the current price per byte and per GB to display to the user

    5. **Create an intent** — `POST /intents` with your API key returns an `intentId` with the price locked in

    6. **Pay on-chain** — Call `payIntent(intentId)` on the contract, sending AI3 as native value

    7. **Submit tx hash** — `POST /intents/:id/watch` with the transaction hash

    8. **Poll for completion** — `GET /intents/:id` until status is `completed`

    9. **Upload content** — Use the Auto Drive SDK with the same API key (credits are now on the account)


    **Note:** A Google-verified account is currently required to purchase credits. API keys inherit the auth provider of the account that created them, so an API key from a Google-registered account satisfies this requirement.


    ## Auto-Drive Services


    Auto-Drive consists of two main services:


    ### 1. Auto-Drive API


    The Storage Service handles all file operations including uploads, downloads, and object management. It provides APIs for:

    - File uploads (single and multipart)

    - Object metadata management

    - Access control and permissions

    - Account management

    - Credit purchases (Pay with AI3)


    ### 2. Auto-Drive Download Gateway


    The Auto-Drive Download Gateway is a service that allows you to download files from the Auto-Drive API. It provides APIs for:

    - File downloads

    - Async downloads'
servers:
- url: https://mainnet.auto-drive.autonomys.xyz
  description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- apiKey: []
  provider: []
tags:
- name: Auto Drive Download Gateway
paths:
  /downloads/async/{cid}:
    post:
      summary: Downloads - Create async download for an object by CID
      tags:
      - Auto Drive Download Gateway
      servers:
      - url: https://public.auto-drive.autonomys.xyz/api
        description: Download Auto Drive Gateway (Mainnet)
      parameters:
      - name: cid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully created async download
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/AsyncDownload'
  /downloads/async/{downloadId}/dismiss:
    post:
      summary: Downloads - Dismiss an async download
      tags:
      - Auto Drive Download Gateway
      servers:
      - url: https://public.auto-drive.autonomys.xyz/api
        description: Download Auto Drive Gateway (Mainnet)
      parameters:
      - name: downloadId
        in: path
        required: true
      responses:
        '200':
          description: Successfully dismissed async download
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/AsyncDownload'
  /downloads/{cid}:
    get:
      summary: Downloads - Download an object by CID
      tags:
      - Auto Drive Download Gateway
      servers:
      - url: https://public.auto-drive.autonomys.xyz/api
        description: Download Auto Drive Gateway (Mainnet)
      parameters:
      - name: cid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved object for download
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          description: Metadata not found
        '500':
          description: Failed to retrieve data
  /downloads/async/{downloadId}:
    get:
      summary: Downloads - Get async download status
      tags:
      - Auto Drive Download Gateway
      servers:
      - url: https://public.auto-drive.autonomys.xyz/api
        description: Download Auto Drive Gateway (Mainnet)
      parameters:
      - name: downloadId
        in: path
        required: true
      responses:
        '200':
          description: Successfully retrieved async download status
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/AsyncDownload'
  /downloads/async/{downloadId}/status:
    get:
      summary: Downloads - Get async download status
      tags:
      - Auto Drive Download Gateway
      servers:
      - url: https://public.auto-drive.autonomys.xyz/api
        description: Download Auto Drive Gateway (Mainnet)
      parameters:
      - name: downloadId
        in: path
        required: true
      responses:
        '200':
          description: Successfully retrieved async download status
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/AsyncDownloadStatus'
  /downloads/async/@me:
    get:
      summary: Downloads - Get all async downloads for the current user
      tags:
      - Auto Drive Download Gateway
      servers:
      - url: https://public.auto-drive.autonomys.xyz/api
        description: Download Auto Drive Gateway (Mainnet)
      responses:
        '200':
          description: Successfully retrieved all async downloads
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AsyncDownload'
components:
  schemas:
    AsyncDownloadStatus:
      type: object
      properties:
        status:
          type: string
          enum:
          - cached
          - not-cached
    AsyncDownload:
      type: object
      properties:
        id:
          type: string
        oauthProvider:
          type: string
        oauthUserId:
          type: string
        cid:
          type: string
        status:
          type: string
          enum:
          - pending
          - downloading
          - completed
          - failed
          - dismissed
        errorMessage:
          type:
          - string
          - 'null'
        fileSize:
          type:
          - number
          - 'null'
        downloadedBytes:
          type:
          - string
          - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'Bearer token for authentication. Example: Bearer <token>. Could be either an API key or a JWT token.'
    provider:
      type: apiKey
      in: header
      name: X-Auth-Provider
      description: 'Used for differentiating between different auth providers. For most use cases: X-Auth-Provider: apikey'