CK-12 Flexi · GPT-Aktionen

{
  "openapi": "3.0.0",
  "info": {
    "title": "Ed-Tech Platform API",
    "version": "1.0.0",
    "description": "API for an educational technology platform, providing access to learning resources."
  },
  "servers": [
    {
      "url": "https://www.ck12.org/"
    }
  ],
  "paths": {
    "/flx/search/learningInfos": {
      "get": {
        "operationId": "learningInfo",
        "summary": "Find lessons by topic",
        "description": "Retrieve lesson details based on a specific topic.",
        "parameters": [
          {
            "name": "term",
            "in": "query",
            "required": true,
            "description": "A search term or keyword related to the lesson content.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "artifactTypes",
            "in": "query",
            "required": true,
            "description": "The artifact type, Must be lesson.",
            "schema": {
              "type": "string",
              "default": "lesson"
            }
          },
          {
            "name": "field",
            "in": "query",
            "required": true,
            "description": "The field to search. Must be title.",
            "schema": {
              "type": "string",
              "default": "title"
            }
          },
          {
            "name": "courseIDs",
            "in": "query",
            "required": true,
            "description": "Course Ids for the search. Must exactly be 429164,4429276,4429414,4313200,4313144,9834555,5675452,5292199,5275795,5306536,5292077,5271771,4283481,5369165,5314712,5630548,6242945,6242941,10498154,10498649,10499013,10533716,10533388,11334303",
            "schema": {
              "type": "string",
              "default": "429164,4429276,4429414,4313200,4313144,9834555,5675452,5292199,5275795,5306536,5292077,5271771,4283481,5369165,5314712,5630548,6242945,6242941,10498154,10498649,10499013,10533716,10533388,11334303"
            }
          },
          {
            "name": "includeCourseSuggestionsOnly",
            "in": "query",
            "required": true,
            "description": "Indicator to include course suggestions only. Must be true",
            "schema": {
              "type": "boolean",
              "default": true
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": true,
            "description": "The page size for retrieval. Must be 3",
            "schema": {
              "type": "integer",
              "default": 3
            }
          },
          {
            "name": "primaryOrRelatedOrBoth",
            "in": "query",
            "required": true,
            "description": "The content type to consider during search. Must be primary",
            "schema": {
              "type": "string",
              "default": "primary"
            }
          },
          {
            "name": "shortLinks",
            "in": "query",
            "required": true,
            "description": "Whether to use short URLs. Must be true",
            "schema": {
              "type": "string",
              "default": "true"
            }
          },
          {
            "name": "referrer",
            "in": "query",
            "required": true,
            "description": "The referrer for the request. Must be FlexiGPT",
            "schema": {
              "type": "string",
              "default": "FlexiGPT"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of lessons matching the search term.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "lessons": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Lesson"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request parameters."
          },
          "404": {
            "description": "No lessons found matching the criteria."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Lesson": {
        "type": "object",
        "properties": {
          "conceptTitle": {
            "type": "string"
          },
          "learnURL": {
            "type": "string"
          },
          "practiceURL": {
            "type": "string"
          },
          "reviewURL": {
            "type": "string"
          },
          "lessonURL": {
            "type": "string"
          },
          "Content Code": {
            "type": "string"
          },
          "courseTitle": {
            "type": "string",
            "nullable": true
          },
          "courseID": {
            "type": "string",
            "nullable": true
          }
        }
      }
    }
  }
}