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

# Register a file in the media library

> Adds an already-hosted file to the library so website sections and content can reference it. The API does not accept file uploads - upload to your image host first (the admin editor uses Cloudinary) and register the resulting URL here.
Idempotent per URL: registering one the organization already has updates whatever metadata you send and returns the existing item, with `created: false`.




## OpenAPI

````yaml /openapi-platform.json post /v1/platform/media
openapi: 3.0.0
info:
  title: 1club Platform API
  version: 1.0.0
  description: >-
    The 1club Platform API lets you programmatically access and manage your
    organization's data.


    ## Official API Contract


    This documentation is the official source of truth for the 1club Platform
    API.

    If an integration relies on undocumented endpoints, fields, response shapes,
    or internal behavior outside this spec, we can't guarantee backward
    compatibility.

    Build against what's documented here to stay stable as the platform evolves.


    ## Authentication


    All requests require a customer API key passed as a Bearer token:


    ```

    Authorization: Bearer 1club_sk_live_...

    ```


    Generate API keys from the admin portal under **Settings > API Tokens**.

    The key is tied to your organization - all responses are scoped to your
    org's data.


    ## Rate Limiting


    - **100 requests per minute** per API key

    - When exceeded, the API returns `429 Too Many Requests` with a
    `Retry-After` header

    - Rate limit headers are included in every response:
      - `X-RateLimit-Limit` - max requests per window
      - `X-RateLimit-Remaining` - requests remaining
      - `X-RateLimit-Reset` - seconds until the window resets

    ## Errors


    | Status | Meaning |

    |--------|---------|

    | `400` | Invalid request parameters |

    | `401` | Missing or invalid API key |

    | `404` | Resource not found (or doesn't belong to your organization) |

    | `429` | Rate limit exceeded |

    | `500` | Internal server error |
  contact:
    name: 1club API Support
    email: support@1club.ai
servers:
  - url: https://api.1club.ai
    description: Production API
security:
  - customerApiAuth: []
tags: []
paths:
  /v1/platform/media:
    post:
      tags:
        - Media
      summary: Register a file in the media library
      description: >
        Adds an already-hosted file to the library so website sections and
        content can reference it. The API does not accept file uploads - upload
        to your image host first (the admin editor uses Cloudinary) and register
        the resulting URL here.

        Idempotent per URL: registering one the organization already has updates
        whatever metadata you send and returns the existing item, with `created:
        false`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  description: Absolute http(s) URL of the file
                name:
                  type: string
                  description: >-
                    Display name. Derived from the URL when omitted - this is
                    what `search` matches on, so a descriptive name is worth
                    sending.
                altText:
                  type: string
                  nullable: true
                  description: >-
                    Alternative text, used by screen readers and searched
                    alongside the name
                caption:
                  type: string
                  nullable: true
                mediaType:
                  type: string
                  enum:
                    - image
                    - video
                  description: Inferred from the URL extension when omitted
      responses:
        '201':
          description: The registered media item
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PlatformMedia'
                  - type: object
                    properties:
                      created:
                        type: boolean
                        description: False when the URL was already in the library
        '400':
          description: Missing or non-http(s) URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '401':
          $ref: '#/components/responses/PlatformUnauthorized'
        '403':
          description: API key is missing the required `media:write` scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '429':
          $ref: '#/components/responses/PlatformRateLimited'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformMedia:
      type: object
      description: >-
        An item in the organization's media library. Files are hosted externally
        (Cloudinary for anything uploaded through the admin editor); this record
        is the library entry that website sections and content reference by
        `url`.
      properties:
        id:
          type: integer
        url:
          type: string
          description: >-
            Public URL of the file. Immutable - register a new item to replace a
            file.
        name:
          type: string
          description: >-
            Display name. Searched, along with altText, when looking an image up
            by name.
        altText:
          type: string
          nullable: true
          description: Alternative text for screen readers. Also searched.
        caption:
          type: string
          nullable: true
        mediaType:
          type: string
          enum:
            - image
            - video
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    PlatformError:
      type: object
      properties:
        error:
          type: string
  responses:
    PlatformUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
    PlatformRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformError'
  securitySchemes:
    customerApiAuth:
      type: http
      scheme: bearer
      description: >-
        Organization-scoped bearer credential: a customer API key
        (1club_sk_live_...) or an MCP OAuth access token.

````