Create new interactive coding lab

POST

public

create-interactive-coding-lab

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-interactive-coding-lab \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "labTitle": "<string>",
        "labDescriptionAsMarkdown": "<string>",
        "defaultGitRepositoryUrl": "<string>",
        "defaultGitRepositoryBranchName": "<string>",
        "evaluationScriptBashCommand": "<string>",
        "evaluationScriptTestFileContent": "<string>",
        "testCases": []
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "labId": "<string>"
      }
    }
  }
]

Authorizations

FERMION-API-KEY

string

header

required

Body

application/json

API Request Body

data

object[]

required

Show child attributes

data.data

object

required

Show child attributes

data.data.labTitle

string

required

Title of the interactive coding lab

Minimum string length: 1

data.data.labDescriptionAsMarkdown

string

required

Markdown description explaining what the lab is about and what students will learn

data.data.defaultGitRepositoryUrl

string<uri>

required

URL of the Git repository that will be cloned as the starting point for this lab

data.data.defaultGitRepositoryBranchName

string

required

Git branch name to use from the repository (e.g., "main" or "master")

data.data.evaluationScriptBashCommand

string

required

Bash command to run for evaluating lab completion (e.g., "npm test" or "python test.py")

data.data.evaluationScriptTestFileContent

string

required

Content of the test file that will be used to evaluate the lab (e.g., unit test code)

data.data.testCases

object[]

Array of test cases/challenges that students need to complete in this lab

Show child attributes

data.data.testCases.type

enum<string>

required

Type of challenge/test case

Available options:

SelfEvaluative,

SystemEvaluative

data.data.testCases.markdownLabel

string

required

Label/title for the test case that will be shown to the student

Minimum string length: 1

data.data.testCases.markdownHint

required

Optional hint in markdown format to help students complete this test case

Response

200 - application/json

API Response Body

output

object

required

Option 1
Option 2

Show child attributes

output.status

enum<string>

required

Available options:

ok

output.data

object

required

Show child attributes

output.data.labId

string

required

The ID of the lab created. Use this to perform further operations on the lab (embedding, updating, etc.)

Delete interactive coding lab Deletes an existing interactive coding lab. Authentication with the "FERMION-API-KEY" header is required to use this endpoint. Rate limit: Maximum 60 requests in a window of 1m.

⌘I

Create new interactive coding lab

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-interactive-coding-lab \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "labTitle": "<string>",
        "labDescriptionAsMarkdown": "<string>",
        "defaultGitRepositoryUrl": "<string>",
        "defaultGitRepositoryBranchName": "<string>",
        "evaluationScriptBashCommand": "<string>",
        "evaluationScriptTestFileContent": "<string>",
        "testCases": []
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "labId": "<string>"
      }
    }
  }
]

Using API

Endpoints

Authorizations

Body

Response