Listen LabsDocs

    Endpoints

    Get Single Response

    Retrieve one response's transcript, URL parameters, and summaries by UUID or readable ID

    GET/api/public/v1/responses/{linkId}/{responseId}
    Request
    curl -X GET 'https://listenlabs.ai/api/public/v1/responses/<linkId>/<responseId>' \
      -H 'x-api-key: <api_key>'
    Response
    JSON
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "readableId": 0,
      "linkId": "string",
      "urlParams": {},
      "tagline": "string",
      "bulletSummary": [
        "string"
      ],
      "transcript": [
        {
          "moderator": "string",
          "user": "string",
          "audio": "https://example.com",
          "video": {
            "streamUrl": "https://example.com",
            "mp4Url": "https://example.com"
          },
          "screenVideo": {
            "streamUrl": "https://example.com",
            "mp4Url": "https://example.com"
          },
          "responseIndex": 0,
          "discussionGuideQuestionId": "string",
          "conceptId": "string",
          "isFollowUp": true,
          "answerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
      ]
    }

    Authorization

    x-api-keystringheaderrequired

    Your workspace API key. See Authentication.

    Path parameters

    linkIdstringrequired

    The study's editable link ID (as used in the response URL) or the study UUID.

    responseIdstring<uuid> | stringrequired

    Response UUID or positive readable numeric ID.

    Responses

    Response details

    idstring<uuid>required
    readableIdintegerrequired
    linkIdstringrequired
    urlParamsmaprequired

    Visible URL parameters.

    taglinestring | nullrequired

    Generated tagline.

    bulletSummarystring[]required

    Generated summary bullets.

    transcriptSingleResponseTranscriptItem[]required