> ## Documentation Index
> Fetch the complete documentation index at: https://autorender.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List sources

> Paginated sources (S3, Azure, Google Cloud, or image source) with search and type filter.

<Note>
  **Key type:** requires a private key. A public key returns `403` here, because it may only
  upload — see [key types and scope](/docs/api-reference/introduction#key-types-and-scope). Call
  this from your server, never from browser code.
</Note>

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://upload.autorender.io/api/v1/sources?page=1&limit=10&type=image_source' \
    --header 'Authorization: Bearer YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "sources": [
      {
        "id": "974628c2-9b55-4ce4-adf1-9b63edff6baa",
        "name": "my_image_source",
        "type": "image_source",
        "configuration": {
          "base_url": "https://cdn.example.com",
          "forward_header": true
        },
        "is_active": true,
        "created_at": "2026-03-27T14:58:53.795Z",
        "updated_at": "2026-03-27T14:58:53.795Z"
      },
      {
        "id": "0a2b6b3a-3b3a-4a7a-9b0a-4a3a7a3a7a3a",
        "name": "my_s3_bucket",
        "type": "s3",
        "configuration": {
          "access_key": "****************",
          "secret_key": "****************************************",
          "region": "us-east-1",
          "bucket": "my-bucket"
        },
        "is_active": true,
        "created_at": "2026-03-20T09:12:03.221Z",
        "updated_at": "2026-03-20T09:12:03.221Z"
      }
    ],
    "meta": {
      "page": 1,
      "limit": 10,
      "total": 2,
      "hasMore": false
    }
  }
  ```

  ```json 401 theme={null}
  {
    "success": false,
    "error": "Invalid API key.",
    "message": "The provided API key is invalid, inactive, or has been deleted"
  }
  ```
</ResponseExample>

## Overview

Returns **`sources`** (your workspace's cloud storage and image-source origins) alongside **`meta`** pagination (`page`, `limit`, `total`, `hasMore`). Filter by name with **`search`** or by **`type`**.

<Note>
  Sensitive configuration fields (`access_key`, `secret_key`, `connection_string`, `service_account_json`) are always masked in the response — the API never returns your stored secrets in plaintext.
</Note>

## Query parameters

| Parameter | Type    | Description                                           |
| --------- | ------- | ----------------------------------------------------- |
| `page`    | integer | Page number (default `1`)                             |
| `limit`   | integer | Page size, 1–100 (default `10`)                       |
| `search`  | string  | Partial, case-insensitive match on source name        |
| `type`    | string  | One of: `s3`, `azure`, `google_cloud`, `image_source` |

## Response fields

**`sources[]`:** `id`, `name`, `type`, `configuration` (secrets masked), `is_active`, `created_at`, `updated_at`

**`meta`:** `page`, `limit`, `total`, `hasMore`

## Next steps

<CardGroup cols={2}>
  <Card title="Create source" icon="plus" iconType="solid" href="/docs/api-reference/create-source">
    Add a new S3, Azure, Google Cloud, or image source.
  </Card>

  <Card title="Source details" icon="circle-info" iconType="solid" href="/docs/api-reference/get-source-details">
    Fetch the full record for one source by its id.
  </Card>
</CardGroup>


## OpenAPI

````yaml api-reference/openapi.json GET /api/v1/sources
openapi: 3.0.0
info:
  title: AutoRender Public API
  description: >-
    REST API for uploading, managing, and serving media assets. All endpoints
    require an API key via the x-api-key header or Authorization: Bearer <key>.
  version: 1.0.0
  contact:
    name: AutoRender Support
    email: support@autorender.io
servers:
  - url: https://app-api.autorender.io
    description: Production server
security:
  - apiKey: []
tags:
  - name: Uploads
    description: Upload endpoints (API key required)
  - name: Files
    description: File management endpoints (API key required)
  - name: Folders
    description: Folder management endpoints (API key required)
  - name: Sources
    description: Source management endpoints (API key required)
paths:
  /api/v1/sources:
    get:
      tags:
        - Sources
      summary: List sources
      description: List/search sources with pagination and filtering.
      operationId: listSources
      parameters:
        - schema:
            type: string
          in: query
          name: search
          required: false
          description: Partial name match (case-insensitive)
        - schema:
            type: string
            enum:
              - s3
              - azure
              - google_cloud
              - image_source
          in: query
          name: type
          required: false
          description: Filter by source type
        - schema:
            default: 1
            type: integer
            minimum: 1
            maximum: 9007199254740991
          in: query
          name: page
          required: false
        - schema:
            default: 10
            type: integer
            minimum: 1
            maximum: 100
          in: query
          name: limit
          required: false
      responses:
        '200':
          description: Sources list
          content:
            application/json:
              schema:
                type: object
                properties:
                  sources:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        name:
                          type: string
                        type:
                          type: string
                          enum:
                            - s3
                            - azure
                            - google_cloud
                            - image_source
                        configuration:
                          type: object
                          properties: {}
                          additionalProperties:
                            x-stainless-any: true
                        is_active:
                          type: boolean
                        created_at:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        updated_at:
                          nullable: true
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                      required:
                        - id
                        - name
                        - type
                        - configuration
                        - is_active
                        - created_at
                        - updated_at
                      additionalProperties: false
                  meta:
                    type: object
                    properties:
                      page:
                        type: integer
                        minimum: 1
                        maximum: 9007199254740991
                      limit:
                        type: integer
                        minimum: 1
                        maximum: 9007199254740991
                      total:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      hasMore:
                        type: boolean
                    required:
                      - page
                      - limit
                      - total
                      - hasMore
                    additionalProperties: false
                required:
                  - sources
                  - meta
                additionalProperties: false
                description: Sources list
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                  - message
                additionalProperties: false
                description: Unauthorized
        '403':
          description: Private API key required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                  - message
                additionalProperties: false
                description: Private API key required
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  retryAfterSeconds:
                    type: number
                required:
                  - error
                  - message
                additionalProperties: false
                description: Rate limit exceeded
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: x-api-key
      in: header
      description: >-
        API key for public endpoints. Can also be provided via Authorization:
        Bearer <key>

````