Creed

Creed Learning Plans API

The learning-plans API from Creed — 3 operation(s) for learning-plans.

GitHub OpenAPI

Operations 6

GET /api/learning-plans/catalog List Catalog #
GET /api/learning-plans/instances List Instances #
POST /api/learning-plans/instances Create Instance #
POST /api/learning-plans/instances/{instance_id}/segments Mark Segment Complete #
GET /api/learning-plans/instances/{instance_id}/reflections List Reflections #
PUT /api/learning-plans/instances/{instance_id}/reflections/{day_index} Save Reflection #

Documentation

📖
APIReference
https://api.usecreed.com/docs
📖
Documentation
https://api.usecreed.com/docs
📖
Authentication
https://artifacts.apis.io/creed/authentication/creed-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/creed/openapi/creed-learning-plans-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/creed/conventions/creed-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/creed/errors/creed-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/creed/data-model/creed-data-model.yml
🔗
Conformance
https://artifacts.apis.io/creed/conformance/creed-conformance.yml
🔗
Lifecycle
https://artifacts.apis.io/creed/lifecycle/creed-lifecycle.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/creed:creed-learning-plans-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

creed-learning-plans-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Creed Learning Plans API
  description: Creed API - Christian AI Chatbot
  version: 1.0.0
tags:
- name: learning-plans
paths:
  /api/learning-plans/catalog:
    get:
      tags:
      - learning-plans
      summary: List Catalog
      operationId: list_catalog_api_learning_plans_catalog_get
      security:
      - HTTPBearer: []
      parameters:
      - name: lang
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Lang
      - name: include_reflections
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Reflections
      - name: include_premium
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Premium
      - name: include_bodies
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Include Bodies
      - name: include_starter_count
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Starter Count
      - name: catalog_version
        in: query
        required: false
        schema:
          type: integer
          default: 1
          title: Catalog Version
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - type: array
                  items:
                    $ref: '#/components/schemas/Plan'
                - $ref: '#/components/schemas/LearningPlanCatalog'
                title: Response List Catalog Api Learning Plans Catalog Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/learning-plans/instances:
    get:
      tags:
      - learning-plans
      summary: List Instances
      operationId: list_instances_api_learning_plans_instances_get
      security:
      - HTTPBearer: []
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LearningPlanInstance'
                title: Response List Instances Api Learning Plans Instances Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - learning-plans
      summary: Create Instance
      operationId: create_instance_api_learning_plans_instances_post
      security:
      - HTTPBearer: []
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartInstanceRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LearningPlanInstance'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/learning-plans/instances/{instance_id}/segments:
    post:
      tags:
      - learning-plans
      summary: Mark Segment Complete
      operationId: mark_segment_complete_api_learning_plans_instances__instance_id__segments_post
      security:
      - HTTPBearer: []
      parameters:
      - name: instance_id
        in: path
        required: true
        schema:
          type: string
          title: Instance Id
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkSegmentRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LearningPlanInstance'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/learning-plans/instances/{instance_id}/reflections:
    get:
      tags:
      - learning-plans
      summary: List Reflections
      operationId: list_reflections_api_learning_plans_instances__instance_id__reflections_get
      security:
      - HTTPBearer: []
      parameters:
      - name: instance_id
        in: path
        required: true
        schema:
          type: string
          title: Instance Id
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LearningPlanReflection'
                title: Response List Reflections Api Learning Plans Instances  Instance Id  Reflections Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/learning-plans/instances/{instance_id}/reflections/{day_index}:
    put:
      tags:
      - learning-plans
      summary: Save Reflection
      description: 'Create or edit one day''s reflection row. Idempotent, so the client can

        re-save freely as the user edits or re-answers.'
      operationId: save_reflection_api_learning_plans_instances__instance_id__reflections__day_index__put
      security:
      - HTTPBearer: []
      parameters:
      - name: instance_id
        in: path
        required: true
        schema:
          type: string
          title: Instance Id
      - name: day_index
        in: path
        required: true
        schema:
          type: integer
          title: Day Index
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveReflectionRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LearningPlanReflection'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    MultipleChoiceQuestion:
      properties:
        format:
          type: string
          const: multiple_choice
          title: Format
        prompt:
          type: string
          title: Prompt
        choices:
          items:
            type: string
          type: array
          title: Choices
        correct_index:
          type: integer
          title: Correct Index
        explanation:
          type: string
          title: Explanation
      type: object
      required:
      - format
      - prompt
      - choices
      - correct_index
      - explanation
      title: MultipleChoiceQuestion
    StartInstanceRequest:
      properties:
        plan_key:
          type: string
          title: Plan Key
      type: object
      required:
      - plan_key
      title: StartInstanceRequest
    LearningPlanInstance:
      properties:
        instance_id:
          type: string
          title: Instance Id
        user_id:
          type: string
          title: User Id
        plan_key:
          type: string
          title: Plan Key
        started_at:
          type: string
          title: Started At
        completed_segments:
          items:
            type: string
          type: array
          title: Completed Segments
      type: object
      required:
      - instance_id
      - user_id
      - plan_key
      - started_at
      title: LearningPlanInstance
    Plan:
      properties:
        key:
          type: string
          title: Key
        title:
          type: string
          title: Title
        author:
          type: string
          title: Author
        duration_days:
          type: integer
          title: Duration Days
        topic:
          type: string
          title: Topic
        description:
          type: string
          title: Description
        premium:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Premium
        days:
          items:
            $ref: '#/components/schemas/PlanDay'
          type: array
          title: Days
      type: object
      required:
      - key
      - title
      - author
      - duration_days
      - topic
      - description
      - days
      title: Plan
    DevotionalSegment:
      properties:
        type:
          type: string
          const: devotional
          title: Type
        title:
          type: string
          title: Title
        body:
          anyOf:
          - type: string
          - type: 'null'
          title: Body
      type: object
      required:
      - type
      - title
      title: DevotionalSegment
    PlanDay:
      properties:
        day_index:
          type: integer
          title: Day Index
        segments:
          items:
            anyOf:
            - $ref: '#/components/schemas/DevotionalSegment'
            - $ref: '#/components/schemas/ScriptureSegment'
            - $ref: '#/components/schemas/ReflectionSegment'
          type: array
          title: Segments
      type: object
      required:
      - day_index
      - segments
      title: PlanDay
    ScriptureReference:
      properties:
        book:
          type: string
          title: Book
        chapter:
          type: integer
          title: Chapter
        verses:
          type: string
          title: Verses
      type: object
      required:
      - book
      - chapter
      - verses
      title: ScriptureReference
    ReflectionSegment:
      properties:
        type:
          type: string
          const: reflection
          title: Type
        questions:
          items:
            anyOf:
            - $ref: '#/components/schemas/MultipleChoiceQuestion'
            - $ref: '#/components/schemas/TrueFalseQuestion'
          type: array
          title: Questions
        reflection_prompt:
          type: string
          title: Reflection Prompt
      type: object
      required:
      - type
      - questions
      - reflection_prompt
      title: ReflectionSegment
    LearningPlanCatalog:
      properties:
        plans:
          items:
            $ref: '#/components/schemas/Plan'
          type: array
          title: Plans
        starter_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Starter Count
      type: object
      required:
      - plans
      title: LearningPlanCatalog
    QuizAnswer:
      properties:
        question_index:
          type: integer
          title: Question Index
        selected_index:
          type: integer
          title: Selected Index
        correct:
          type: boolean
          title: Correct
      type: object
      required:
      - question_index
      - selected_index
      - correct
      title: QuizAnswer
    MarkSegmentRequest:
      properties:
        day_index:
          type: integer
          title: Day Index
        segment_type:
          type: string
          enum:
          - devotional
          - scripture
          - reflection
          title: Segment Type
      type: object
      required:
      - day_index
      - segment_type
      title: MarkSegmentRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TrueFalseQuestion:
      properties:
        format:
          type: string
          const: true_false
          title: Format
        prompt:
          type: string
          title: Prompt
        correct:
          type: boolean
          title: Correct
        explanation:
          type: string
          title: Explanation
      type: object
      required:
      - format
      - prompt
      - correct
      - explanation
      title: TrueFalseQuestion
    ScriptureSegment:
      properties:
        type:
          type: string
          const: scripture
          title: Type
        reference:
          $ref: '#/components/schemas/ScriptureReference'
      type: object
      required:
      - type
      - reference
      title: ScriptureSegment
    SaveReflectionRequest:
      properties:
        body:
          anyOf:
          - type: string
            maxLength: 10000
          - type: 'null'
          title: Body
        quiz_answers:
          anyOf:
          - items:
              $ref: '#/components/schemas/QuizAnswer'
            type: array
          - type: 'null'
          title: Quiz Answers
      type: object
      title: SaveReflectionRequest
      description: 'Both fields are optional and written independently: the quiz is saved as

        the user taps an answer, the reflection when they finish the day. Omitting a

        field leaves the stored value untouched.'
    LearningPlanReflection:
      properties:
        instance_id:
          type: string
          title: Instance Id
        day_index:
          type: integer
          title: Day Index
        body:
          type: string
          title: Body
        quiz_answers:
          items:
            $ref: '#/components/schemas/QuizAnswer'
          type: array
          title: Quiz Answers
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - instance_id
      - day_index
      - body
      - created_at
      - updated_at
      title: LearningPlanReflection
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Supabase JWT token
x-provenance:
  method: harvested
  publisher: Creed
  source: https://api.usecreed.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)