Aidelly AI Approval Settings API

openapi: 3.2.0
info:
  title: Aidelly Public Approval Settings API
  version: 1.1.0
  x-versioning-policy: https://www.aidelly.ai/developers/api/deprecation
  description: 'Customer-facing API for publishing and scheduling social posts through Aidelly.

    All responses use `{ success, data | error, request_id }`.


    This API is optimized for single-user project integrations and AI agents:

    - deterministic error codes

    - required idempotency on writes

    - plan-aware rate-limit headers on authenticated responses'
servers:
- url: https://app.aidelly.ai/api/public/v1
security:
- bearerAuth: []
tags:
- name: ApprovalSettings
  description: 'Workspace approval gate settings — the "require member approval"

    toggle that drives the Team Approvals queue. Public API preview.'
paths:
  /workspaces/{workspaceId}/approval-settings:
    get:
      tags:
      - ApprovalSettings
      summary: Get the workspace's approval settings
      operationId: getApprovalSettings
      parameters:
      - in: path
        name: workspaceId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Current settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      requireMemberApproval:
                        type: boolean
                      requireOwnerReview:
                        type: boolean
                        description: When true, posts created by the workspace owner wait for explicit owner approval.
                      canEdit:
                        type: boolean
                      canEditOwnerReview:
                        type: boolean
                  request_id:
                    type: string
      x-tool-name: aidelly_get_approval_settings
      x-scope: workspaces:read
      x-tool-description: Read the workspace's approval settings for member submissions and owner review. Read-only.
      security:
      - bearerAuth: []
      - oauth2:
        - workspaces:read
      description: Read the workspace's approval settings for member submissions and owner review. Read-only.
    patch:
      tags:
      - ApprovalSettings
      summary: Update the workspace's approval settings
      description: 'Public API preview. Workspace settings editors may update team approval

        fields. Only the workspace owner may update `requireOwnerReview`.'
      operationId: updateApprovalSettings
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - in: path
        name: workspaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                requireMemberApproval:
                  type: boolean
                requireOwnerReview:
                  type: boolean
                  description: Hold posts created by the workspace owner for explicit owner approval.
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/EnvelopeBase'
                - type: object
                  properties:
                    success:
                      const: true
                    data:
                      $ref: '#/components/schemas/ApprovalSettingsResponse'
      x-tool-name: aidelly_update_approval_settings
      x-scope: workspaces:write
      x-tool-description: 'Update the workspace''s approval settings for member submissions and owner review. Only the workspace owner can change owner review. Retry-safe: a repeat call with the same idempotency_key returns the original result.'
      security:
      - bearerAuth: []
      - oauth2:
        - workspaces:write
components:
  schemas:
    EnvelopeBase:
      type: object
      required:
      - success
      - request_id
      properties:
        success:
          type: boolean
        request_id:
          type: string
          format: uuid
    ApprovalSettingsResponse:
      type: object
      properties:
        requireMemberApproval:
          type: boolean
        requireOwnerReview:
          type: boolean
        requiredApproverIds:
          type: array
          items:
            type: string
            format: uuid
        approvalsDefaultTab:
          type: string
        canEdit:
          type: boolean
        canEditOwnerReview:
          type: boolean
  parameters:
    IdempotencyKey:
      in: header
      name: Idempotency-Key
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 255
        pattern: ^[\x21-\x7E]{1,255}$
        example: order-123:create-post:v1
      description: 'Required on all write endpoints. 1-255 printable ASCII characters (0x21-0x7E): letters, digits, and punctuation such as `-`, `_`, `.`, and `:` are allowed; spaces, control characters, and non-ASCII are not. Leading and trailing whitespace is trimmed. An invalid key returns 400 `PUBLIC_API_IDEMPOTENCY_KEY_INVALID`; a missing key returns 400 `PUBLIC_API_IDEMPOTENCY_REQUIRED`. Keys are scoped to the API key, method, and path.'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.aidelly.ai/api/mcp/oauth/authorize
          tokenUrl: https://app.aidelly.ai/api/mcp/oauth/token
          refreshUrl: https://app.aidelly.ai/api/mcp/oauth/token
          scopes:
            posts:write: Create and modify posts
            posts:read: Read access to posts
            photos:write: Create and modify photos
            media:write: Create and modify media
            connections:read: Read access to connections
            webhooks:manage: Manage webhooks
            approvals:read: Read access to approvals
            approvals:write: Create and modify approvals
            inbox:read: Read access to inbox
            inbox:write: Create and modify inbox
            automations:read: Read access to automations
            automations:write: Create and modify automations
            queues:read: Read access to queues
            queues:write: Create and modify queues
            destination-presets:read: Read access to destination-presets
            destination-presets:write: Create and modify destination-presets
            calendar:read: Read access to calendar
            calendar:write: Create and modify calendar
            analytics:read: Read access to analytics
            analytics:write: Create and modify analytics
            brand:read: Read access to brand
            brand:write: Create and modify brand
            workspaces:read: Read access to workspaces
            workspaces:write: Create and modify workspaces
            team:read: Read access to team
            team:write: Create and modify team
            repurpose:read: Read access to repurpose
            repurpose:write: Create and modify repurpose
            ideas:read: Read access to ideas
            ideas:write: Create and modify ideas
            links:read: Read access to links
            links:write: Create and modify links
            connect_links:read: Read access to connect_links
            connect_links:write: Create and modify connect_links
            bio:read: Read access to bio
            bio:write: Create and modify bio
            image_editor:read: Read access to image_editor
            image_editor:write: Create and modify image_editor
            viral_trends:read: Read access to viral_trends
            creators:read: Read access to creators
            creators:write: Create and modify creators
            competitors:read: Read access to competitors
            competitors:write: Create and modify competitors
            reports:read: Read access to reports
            reports:write: Create and modify reports
            tasks:read: Read access to tasks
            tasks:write: Create and modify tasks
            white-label:read: Read access to white-label
            white-label:write: Create and modify white-label
            drafts:read: Read access to drafts
            drafts:write: Create and modify drafts
            activity:read: Read access to activity
            credits:read: Read access to credits
            comments:read: Read access to comments
            comments:write: Create and modify comments
            prompts:read: Read access to prompts
            prompts:write: Create and modify prompts
externalDocs:
  description: Aidelly developer documentation and API lifecycle policy
  url: https://www.aidelly.ai/docs