Skip to main content
GET
/
v1
/
interviews
/
{interview_id}
Get interview
curl --request GET \
  --url https://app.ribbon.ai/be-api/v1/interviews/{interview_id} \
  --header 'Authorization: Bearer <token>'
{
  "interview_flow_id": "<string>",
  "interview_id": "<string>",
  "status": "incomplete",
  "interview_data": {
    "transcript": "<string>",
    "transcript_with_timestamp": [
      {
        "content": "<string>",
        "role": "<string>",
        "words": [
          {
            "end": 123,
            "start": 123,
            "word": "<string>"
          }
        ]
      }
    ],
    "questions_to_transcript_mapping": [
      {
        "script_question": "<string>",
        "transcript_item_indices": [
          123
        ],
        "start_timestamp": 123,
        "end_timestamp": 123,
        "transcript_items": [
          {
            "content": "<string>",
            "role": "<string>"
          }
        ]
      }
    ],
    "audio_url": null,
    "video_url": null,
    "summary": null,
    "scores": {
      "communication": null,
      "motivation": null,
      "skills": null,
      "language_vocabulary_and_expression": null,
      "language_grammar_and_structure": null,
      "language_fluency_and_pace": null,
      "language_comprehension": null
    },
    "interviewee_email_address": null,
    "interviewee_first_name": null,
    "interviewee_last_name": null
  }
}

Authorizations

Authorization
string
header
required

Provide your API key UUID in the 'Authorization' header prefixed with 'Bearer '. Example: 'Authorization: Bearer 123e4567-e89b-12d3-a456-426614174000'

Path Parameters

interview_id
string
required
Minimum string length: 1

Response

OK

interview_flow_id
string
required

The ID of the interview flow.

interview_id
string
required

The ID of the interview.

status
enum<string>
required

The status of the interview.

Available options:
incomplete,
completed
interview_data
object
required

Data for the completed interview. If the interview is incomplete, this field will be null.