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

# Neuen API-Schlüssel erstellen



## OpenAPI

````yaml /de/openapi.json post /v1/settings/api-keys
openapi: 3.0.0
info:
  title: Social media studio API
  description: >-
    Die Social media studio API ermöglicht es dir, deinen Social-Media-Workflow
    programmatisch zu steuern – Beiträge erstellen und planen, Medien
    organisieren, Analysen abrufen, dein Team verwalten und mehr.


    ## Basis-URL


    ```

    https://api.so-me.studio

    ```


    ## Authentifizierung


    Alle `/v1/*`-Endpunkte erfordern einen API-Schlüssel, der im Header
    `X-API-Key` übergeben wird.


    ```

    X-API-Key: sk_live_xxxxxxxxxxxxxxxxxxxxxxxx

    ```


    ## Scopes


    Ein Schlüssel hat vollen Zugriff, es sei denn, du vergibst beim Erstellen
    Scopes. Ein Schlüssel mit Scopes kann nur die Endpunkte aufrufen, die seine
    Scopes abdecken; andere Endpunkte liefern `403 Forbidden`. Ein
    `GET`-Endpunkt benötigt `<resource>:read`; `POST`, `PUT`, `PATCH` und
    `DELETE` benötigen `<resource>:write`, was `read` einschließt. Ressourcen:
    `accounts`, `posts` (auch Entwürfe und Freigaben), `media`, `analytics` (nur
    lesend), `inbox`, `ai`, `biolinks`, `teams`, `settings`, `webhooks`,
    `support`, `templates` (nur lesend), `whatsapp`. Die Endpunkte für
    API-Schlüssel und Workspaces unter `/v1/settings` sowie `PATCH
    /v1/settings/profile` erfordern einen Schlüssel mit vollem Zugriff.
    Schlüssel mit Scopes können den MCP-Server nicht nutzen.


    ## API-Schlüssel erhalten


    1. Melde dich bei deinem Workspace in [Social media
    studio](https://so-me.studio/de) an

    2. Gehe zu **Einstellungen** > Tab **API**

    3. Klicke auf **Neuer API-Schlüssel**, vergib einen Namen und kopiere den
    Schlüssel


    > Der vollständige Schlüssel wird nur einmal angezeigt. Bewahre ihn sicher
    auf.


    ## Rate Limits


    60 Anfragen pro Minute und Workspace. Wenn du dieses Limit überschreitest,
    erhältst du eine Antwort `429 Too Many Requests`.


    ## Tarife


    Der API-Zugriff ist in den Tarifen **Standard**, **Advanced** und
    **Lifetime** verfügbar.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.so-me.studio
    description: Produktion
security: []
tags:
  - name: Posts
    description: Social-Media-Beiträge erstellen, verwalten, planen und veröffentlichen
  - name: Accounts
    description: Verbundene Social-Media-Konten verwalten
  - name: Drafts
    description: Entwürfe erstellen und verwalten
  - name: Media
    description: Mediendateien und Ordner hochladen, organisieren und verwalten
  - name: Analytics
    description: >-
      Analysen auf Plattform- und Beitragsebene über alle Social-Media-Konten
      hinweg
  - name: Inbox
    description: >-
      Unterhaltungen, Antworten und gespeicherte Antworten im
      Social-Media-Posteingang
  - name: AI
    description: KI-gestützte Text- und Bildgenerierung
  - name: Approvals
    description: Freigabe-Workflow für Beiträge zur Zusammenarbeit im Team
  - name: Teams
    description: Verwaltung von Teammitgliedern und Einladungen
  - name: Biolinks
    description: Biolink-Seiten mit Buttons, Beiträgen und Themes
  - name: Settings
    description: Profil, Organisation, API-Schlüssel, Abrechnung und Nutzung
  - name: Authentication
    description: Registrierung, Anmeldung, Passwort zurücksetzen und Geräte-Autorisierung
  - name: Plans
    description: Verfügbare Abonnement-Tarife, Funktionen und Add-ons
  - name: Public Biolink
    description: >-
      Auflösung öffentlicher Biolink-Seiten und Analyse-Tracking (keine
      Authentifizierung erforderlich)
paths:
  /v1/settings/api-keys:
    post:
      tags:
        - Settings
      summary: Neuen API-Schlüssel erstellen
      operationId: V1SettingsController_createApiKey
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Name des API-Schlüssels (max. 80 Zeichen)
                expiresAt:
                  type: string
                  format: date-time
                  description: Optionales Ablaufdatum
                scopes:
                  type: array
                  description: >-
                    Scopes für den neuen Schlüssel. Weglassen für einen
                    Schlüssel mit vollem Zugriff. `<resource>:write` schließt
                    `<resource>:read` ein.
                  items:
                    type: string
                    enum:
                      - accounts:read
                      - accounts:write
                      - posts:read
                      - posts:write
                      - media:read
                      - media:write
                      - analytics:read
                      - inbox:read
                      - inbox:write
                      - ai:read
                      - ai:write
                      - biolinks:read
                      - biolinks:write
                      - teams:read
                      - teams:write
                      - settings:read
                      - settings:write
                      - webhooks:read
                      - webhooks:write
                      - support:read
                      - support:write
                      - templates:read
                      - whatsapp:read
                      - whatsapp:write
                  example:
                    - accounts:read
                    - posts:write
                    - media:write
              required:
                - name
      responses:
        '201':
          description: API-Schlüssel erstellt
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Schlüssel-UUID
                  name:
                    type: string
                    description: Name des Schlüssels
                  keyPrefix:
                    type: string
                    description: Schlüsselpräfix zur Identifizierung
                  scopes:
                    type: array
                    nullable: true
                    items:
                      type: string
                    description: Scopes des Schlüssels; null bedeutet vollen Zugriff
                  fullKey:
                    type: string
                    description: Vollständiger API-Schlüssel (wird nur einmal angezeigt)
                  createdAt:
                    type: string
                    format: date-time
      security:
        - X-API-Key: []
components:
  securitySchemes:
    X-API-Key:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.