VIviewpoints
Studies

Get study creation job status

Changed on

Poll the status of a study creation job. Returns processing while the study is being generated, completed with the study ID when done, or failed if an error occurred.

get/v1/studies/jobs/{job_id}

Request

  • Base URL
    https://api.viewpoints.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

job_idstring required

The job ID returned by the create study endpoint

Response

Job completed or failed

analyze_doneinteger nullable
analyze_item_elapsed_msinteger nullable
analyze_item_expected_msinteger nullable
analyze_totalinteger nullable
analyze_video_secondsinteger nullable
deliberation_phasestring nullable
error_messagestring nullable
has_analyzing_mediaboolean nullable
has_deliberationboolean nullable
has_documentsboolean nullable
has_enriched_contextboolean nullable
has_life_storiesboolean nullable
has_mediaboolean nullable
has_qualitative_questionsboolean nullable
job_unknownboolean nullable
jury_panel_sizeinteger nullable
media_doneinteger nullable
media_item_elapsed_msinteger nullable
media_item_expected_msinteger nullable
media_totalinteger nullable
number_participantsinteger nullable
phasestring nullable
phase_entered_at_msinteger nullable
progressnumber nullable
qual_questions_countinteger nullable
question_block_countinteger nullable
status'processing' | 'preparing_context' | 'completed' | 'failed' required
study_idstring nullable
titlestring nullable

Changes

  • 7865470f2595Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 244932b69978Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status