Listen LabsDocs

    Endpoints

    Create Study

    Validate a study guide and create a draft study in your workspace

    POST/api/public/v1/studies/create
    Request
    curl -X POST 'https://listenlabs.ai/api/public/v1/studies/create' \
      -H 'x-api-key: <api_key>' \
      -H 'Content-Type: application/json' \
      -d '{
      "title": "string",
      "studyGuide": [
        {
          "type": "flat",
          "title": "string",
          "items": [
            {
              "text": "string",
              "type": "open_ended"
            }
          ]
        }
      ]
    }'
    Response
    JSON
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "linkId": "string",
      "status": "draft"
    }

    Authorization

    x-api-keystringheaderrequired

    Your workspace API key. See Authentication.

    Bodyapplication/json

    titlestringrequired
    externalTitlestring
    backgroundstring
    studyGoalstring
    configConfig
    welcomeMessageWelcomeMessage
    closingMessagestring
    studyGuideBlock[]required

    Responses

    Draft created

    idstring<uuid>required
    linkIdstringrequired
    statusstringrequired

    One of: draft