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

# Submit a learning suggestion

> Proposes a catalogue item. The submission is pending until a global administrator approves or rejects it.

**Requires scope:** `learning:write`.



## OpenAPI

````yaml /api-docs/openapi.v1.json post /api/v1/learning-suggestions
openapi: 3.0.0
info:
  title: SkillsDB Public API
  description: >-
    The SkillsDB public REST API. Authenticate every request with an API key
    created in Settings → API Credentials, sent as `Authorization: Bearer
    sdb_live_…`. Errors follow RFC 9457 problem details; every `type` URI
    resolves under https://help.skillsdb.com/api-docs/errors/.
  version: '1'
  contact: {}
servers:
  - url: https://prod.skillsdbnext.com
    description: Production
  - url: https://staging.skillsdbnext.com
    description: Staging
security: []
tags: []
paths:
  /api/v1/learning-suggestions:
    post:
      tags:
        - Learning Suggestion
      summary: Submit a learning suggestion
      description: >-
        Proposes a catalogue item. The submission is pending until a global
        administrator approves or rejects it.


        **Requires scope:** `learning:write`.
      operationId: createLearningSuggestion
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Any unique string (at most 200 characters). Retrying with the same
            key and identical content replays the stored response for 24h
            instead of executing twice.
          schema:
            type: string
            maxLength: 200
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLearningSuggestionDto'
      responses:
        '201':
          description: The created resource, enveloped.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/LearningSuggestionDto'
          headers:
            X-Request-Id:
              description: Unique id for this request — quote it when contacting support.
              schema:
                type: string
            RateLimit-Limit:
              description: The bucket's hourly allowance.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            Idempotency-Replayed:
              description: >-
                `true` when this response was replayed from a previous execution
                under the same Idempotency-Key.
              schema:
                type: string
        '400':
          description: >-
            Validation failed
            (`https://help.skillsdb.com/api-docs/errors/validation-error`)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
          headers:
            X-Request-Id:
              description: Unique id for this request — quote it when contacting support.
              schema:
                type: string
            RateLimit-Limit:
              description: The bucket's hourly allowance.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
        '401':
          description: >-
            Invalid credential
            (`https://help.skillsdb.com/api-docs/errors/invalid-credential`)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
          headers:
            X-Request-Id:
              description: Unique id for this request — quote it when contacting support.
              schema:
                type: string
            RateLimit-Limit:
              description: The bucket's hourly allowance.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
        '403':
          description: >-
            Insufficient scope
            (`https://help.skillsdb.com/api-docs/errors/insufficient-scope`) ·
            Insufficient permissions
            (`https://help.skillsdb.com/api-docs/errors/insufficient-permissions`)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
          headers:
            X-Request-Id:
              description: Unique id for this request — quote it when contacting support.
              schema:
                type: string
            RateLimit-Limit:
              description: The bucket's hourly allowance.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
        '404':
          description: Not found (`https://help.skillsdb.com/api-docs/errors/not-found`)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
          headers:
            X-Request-Id:
              description: Unique id for this request — quote it when contacting support.
              schema:
                type: string
            RateLimit-Limit:
              description: The bucket's hourly allowance.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
        '409':
          description: >-
            Idempotency key reused with different content
            (`https://help.skillsdb.com/api-docs/errors/idempotency-key-reused`)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
          headers:
            X-Request-Id:
              description: Unique id for this request — quote it when contacting support.
              schema:
                type: string
            RateLimit-Limit:
              description: The bucket's hourly allowance.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
        '429':
          description: >-
            Rate limit exceeded
            (`https://help.skillsdb.com/api-docs/errors/rate-limit-exceeded`)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
          headers:
            X-Request-Id:
              description: Unique id for this request — quote it when contacting support.
              schema:
                type: string
            RateLimit-Limit:
              description: The bucket's hourly allowance.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
        '500':
          description: >-
            Internal error
            (`https://help.skillsdb.com/api-docs/errors/internal-error`)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
          headers:
            X-Request-Id:
              description: Unique id for this request — quote it when contacting support.
              schema:
                type: string
            RateLimit-Limit:
              description: The bucket's hourly allowance.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requests left in the current window.
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
      security:
        - apiKey:
            - learning:write
components:
  schemas:
    CreateLearningSuggestionDto:
      type: object
      properties:
        description:
          type: string
          example: Annual refresher for licensed operators.
          maxLength: 4000
          nullable: true
        url:
          type: string
          example: https://learn.example.com/forklift
          maxLength: 500
          nullable: true
        durationHours:
          type: number
          example: 2.5
          nullable: true
        cost:
          type: number
          example: 120
          nullable: true
        costDescription:
          type: string
          example: Per seat
          maxLength: 500
          nullable: true
        providerId:
          type: string
          example: '3'
          nullable: true
          description: Training provider id (reference list).
        formatId:
          type: string
          example: '2'
          nullable: true
          description: Training format id (reference list).
        audienceId:
          type: string
          example: '1'
          nullable: true
          description: Training audience id (reference list).
        courseLevelId:
          type: string
          example: '4'
          nullable: true
          description: Training course level id (reference list).
        referenceId:
          type: string
          example: LMS-4471
          maxLength: 100
          nullable: true
        title:
          type: string
          example: Advanced Rigging
          maxLength: 500
        typeId:
          type: string
          example: '1'
          description: Learning type id.
        note:
          type: string
          example: Needed for the crane team.
          maxLength: 1000
        skillIds:
          description: Skill ids the item is proposed for.
          type: array
          items:
            type: string
        careerIds:
          description: Career ids the item is proposed for.
          type: array
          items:
            type: string
      required:
        - title
    LearningSuggestionDto:
      type: object
      properties:
        id:
          type: string
          example: '530'
          description: Opaque suggestion id (becomes the learning item id on approval).
        title:
          type: string
          example: Advanced Rigging
        description:
          type: string
          example: null
          nullable: true
        url:
          type: string
          example: https://learn.example.com/rigging
          nullable: true
        durationHours:
          type: number
          example: 8
          nullable: true
        cost:
          type: number
          example: 450
          nullable: true
        type:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ReferenceEntryRefDto'
        provider:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ReferenceEntryRefDto'
        format:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ReferenceEntryRefDto'
        audience:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ReferenceEntryRefDto'
        courseLevel:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ReferenceEntryRefDto'
        referenceId:
          type: string
          example: null
          nullable: true
        note:
          type: string
          example: Needed for the crane team.
          nullable: true
          description: The submitter's note.
        suggestedSkillIds:
          example:
            - '77'
          description: Skills the item is proposed for.
          type: array
          items:
            type: string
        suggestedCareerIds:
          example:
            - '31'
          description: Careers the item is proposed for.
          type: array
          items:
            type: string
        status:
          type: string
          enum:
            - pending
            - approved
            - rejected
          example: pending
        submittedById:
          type: string
          example: '1042'
          nullable: true
        submittedAt:
          type: string
          example: '2026-03-01T09:00:00.000Z'
          nullable: true
        approvedById:
          type: string
          example: null
          nullable: true
        approvedAt:
          type: string
          example: null
          nullable: true
        rejectedById:
          type: string
          example: null
          nullable: true
        rejectedAt:
          type: string
          example: null
          nullable: true
        rejectionReason:
          type: string
          example: null
          nullable: true
        modifiedOnApproval:
          type: boolean
          example: false
          description: >-
            True when an administrator changed the submission before approving
            it (the original submission is retained internally).
      required:
        - id
        - title
        - description
        - url
        - durationHours
        - cost
        - type
        - provider
        - format
        - audience
        - courseLevel
        - referenceId
        - note
        - suggestedSkillIds
        - suggestedCareerIds
        - status
        - submittedById
        - submittedAt
        - approvedById
        - approvedAt
        - rejectedById
        - rejectedAt
        - rejectionReason
        - modifiedOnApproval
    ProblemDetailsDto:
      type: object
      properties:
        type:
          type: string
          example: https://help.skillsdb.com/api-docs/errors/validation-error
          description: >-
            A URI identifying the problem type — always resolves to a
            documentation page.
        title:
          type: string
          example: Validation failed
        status:
          type: number
          example: 400
        detail:
          type: string
          example: limit must be between 1 and 200
          description: Human-readable explanation specific to this occurrence.
        instance:
          type: string
          example: /api/v1/people
        requestId:
          type: string
          example: 0192c2f1-6f4e-7ab3-b1c4-5f6a7b8c9d0e
          description: >-
            Matches the X-Request-Id response header — quote it when contacting
            support.
        errors:
          description: Field-level failures, present on validation-error problems.
          type: array
          items:
            $ref: '#/components/schemas/ProblemFieldErrorDto'
        error:
          type: string
          example: trial_expired
          enum:
            - trial_expired
          description: >-
            Present only on a 403 when the workspace's trial has expired, so API
            access is suspended.
        upgrade_url:
          type: string
          example: https://app.skillsdb.com/settings/billing
          description: >-
            Present only alongside `error: trial_expired`: where a workspace
            admin upgrades to restore API access.
      required:
        - type
        - title
        - status
        - detail
        - instance
        - requestId
    ReferenceEntryRefDto:
      type: object
      properties:
        id:
          type: string
          example: '3'
          description: Opaque reference entry id.
        name:
          type: string
          example: Online course
      required:
        - id
        - name
    ProblemFieldErrorDto:
      type: object
      properties:
        field:
          type: string
          example: email
        code:
          type: string
          example: max_length
        message:
          type: string
          example: email must be shorter than or equal to 75 characters
      required:
        - field
        - code
        - message
  securitySchemes:
    apiKey:
      scheme: bearer
      type: http
      description: >-
        An API key issued by a company administrator — an environment prefix
        (production: `sdb_live_`) followed by 32 characters. The prefix
        identifies the environment and MUST NOT be hard-coded or validated by
        clients; treat the whole key as opaque. Shown exactly once at creation;
        only a one-way hash is stored.


        **Scopes** (granted per key on the create screen; `:write` never implies
        `:read`):


        - `skills:read`

        - `skills:write`

        - `people:read`

        - `people:write`

        - `careers:read`

        - `careers:write`

        - `training:read`

        - `training:write`

        - `flags:read`

        - `flags:write`

        - `org:read`

        - `org:write`

        - `assessments:read`

        - `learning:read`

        - `learning:write`

        - `certifications:read`

        - `certifications:write`

        - `assessments:write`

        - `proficiency:read`

        - `proficiency:write`

        - `surveys:read`

        - `surveys:write`

        - `labels:read`

        - `labels:write`

````