Entretiens

GET /engagements/{engagement}/interviews

Lecture engagements.interviews.index

Paramètres

engagement chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/interviews" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/interviews/preview-session

Écriture engagements.interviews.preview

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

population_id string | null

longueur : exactement 26
mode object

une valeur parmi voice_screen voice_only text_simulation
locale string | null

longueur : au plus 8
client_info array<object> | null
client_info.os string | null

longueur : au plus 64
client_info.browser string | null

longueur : au plus 64
client_info.device_class string | null

longueur : au plus 64

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/interviews/preview-session" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"population_id":"01JABCDEFGHJKMNPQRSTVWXYZ0","mode":"voice_screen","locale":"…"}'

POST /engagements/{engagement}/interviews/test

Écriture engagements.interviews.test

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

population_id string | null

longueur : exactement 26
mode object

une valeur parmi voice_screen voice_only text_simulation
locale string | null

longueur : au plus 8
client_info array<object> | null
client_info.os string | null

longueur : au plus 64
client_info.browser string | null

longueur : au plus 64
client_info.device_class string | null

longueur : au plus 64

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/interviews/test" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"population_id":"01JABCDEFGHJKMNPQRSTVWXYZ0","mode":"voice_screen","locale":"…"}'

GET /engagements/{engagement}/live-sessions

Lecture engagements.live-sessions

Paramètres

engagement chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/live-sessions" \
  -H "Authorization: Bearer pat_…"

GET /interviews/{interview}

Lecture interviews.show

Paramètres

interview chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/interviews/{interview}" \
  -H "Authorization: Bearer pat_…"

GET /interviews/{interview}/chapters

Lecture interviews.chapters

Paramètres

interview chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/interviews/{interview}/chapters" \
  -H "Authorization: Bearer pat_…"

GET /interviews/{interview}/chapters/{chapter}/recap

Lecture interviews.chapters.recap

Paramètres

interview chemin: Identifiant (ULID).
chapter chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/interviews/{interview}/chapters/{chapter}/recap" \
  -H "Authorization: Bearer pat_…"

GET /interviews/{interview}/sources/{type}/{source}

Lecture interviews.sources.show

Paramètres

interview chemin: Identifiant (ULID).
type chemin: Identifiant (ULID).
source chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/interviews/{interview}/sources/{type}/{source}" \
  -H "Authorization: Bearer pat_…"

GET /media-thumbnails/{disk}/{path}

Lecture interviews.media.thumbnail

Paramètres

disk chemin: Valeur d’une liste fixe (type, langue, niveau…).
path chemin: Valeur d’une liste fixe (type, langue, niveau…).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/media-thumbnails/{disk}/{path}" \
  -H "Authorization: Bearer pat_…"

GET /media/{disk}/{path}

Lecture interviews.media

Paramètres

disk chemin: Valeur d’une liste fixe (type, langue, niveau…).
path chemin: Valeur d’une liste fixe (type, langue, niveau…).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/media/{disk}/{path}" \
  -H "Authorization: Bearer pat_…"

GET /sessions/{session}

Lecture sessions.show

Paramètres

session chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/sessions/{session}" \
  -H "Authorization: Bearer pat_…"

GET /sessions/{session}/artifacts

Lecture sessions.artifacts

Paramètres

session chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/sessions/{session}/artifacts" \
  -H "Authorization: Bearer pat_…"

POST /sessions/{session}/end

Écriture sessions.end

Paramètres

session chemin: Identifiant (ULID).

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/sessions/{session}/end" \
  -H "Authorization: Bearer pat_…"

GET /sessions/{session}/frames

Lecture sessions.frames

Paramètres

session chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/sessions/{session}/frames" \
  -H "Authorization: Bearer pat_…"

GET /sessions/{session}/frames/latest

Lecture sessions.frames.latest

Paramètres

session chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/sessions/{session}/frames/latest" \
  -H "Authorization: Bearer pat_…"

GET /sessions/{session}/pins

Lecture sessions.pins

Paramètres

session chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/sessions/{session}/pins" \
  -H "Authorization: Bearer pat_…"

GET /sessions/{session}/recordings/{recording}/stream

Lecture sessions.recordings.stream

Paramètres

session chemin: Identifiant (ULID).
recording chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/sessions/{session}/recordings/{recording}/stream" \
  -H "Authorization: Bearer pat_…"

GET /sessions/{session}/transcript

Lecture sessions.transcript

Paramètres

session chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/sessions/{session}/transcript" \
  -H "Authorization: Bearer pat_…"