Méthodes

GET /guide/{ownerType}/{ownerId}/effective

Lecture guide.effective

Paramètres

ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId 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/guide/{ownerType}/{ownerId}/effective" \
  -H "Authorization: Bearer pat_…"

PUT /guide/{ownerType}/{ownerId}/overrides/{topic}

Écriture guide.overrides.put

Paramètres

ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).
topic chemin: Identifiant (ULID).

Corps application/json

operation object requis

une valeur parmi modify remove make_optional make_mandatory
patch array<object> | null
patch.title string

longueur : au plus 255
patch.description string

longueur : au plus 4000
patch.depth object

une valeur parmi overview standard deep
patch.opening_questions array<string>

éléments : au plus 20
patch.information_targets array<object>

éléments : au plus 20
patch.information_targets[].key string requis
patch.information_targets[].label string requis

longueur : au plus 255
patch.demonstrations array<string>

éléments : au plus 20
patch.forbidden_subjects array<string>

éléments : au plus 20

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 -X PUT "https://{votre-espace}.tellmehow.io/api/v1/guide/{ownerType}/{ownerId}/overrides/{topic}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"operation":"modify"}'

DELETE /guide/{ownerType}/{ownerId}/overrides/{topic}

Écriture guide.overrides.destroy

Paramètres

ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).
topic chemin: Identifiant (ULID).

Réponses

204 Supprimé, sans contenu.
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 DELETE "https://{votre-espace}.tellmehow.io/api/v1/guide/{ownerType}/{ownerId}/overrides/{topic}" \
  -H "Authorization: Bearer pat_…"

GET /guide/{ownerType}/{ownerId}/proposals/{proposal}

Lecture guide.proposals.show

Paramètres

ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).
proposal 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/guide/{ownerType}/{ownerId}/proposals/{proposal}" \
  -H "Authorization: Bearer pat_…"

POST /guide/{ownerType}/{ownerId}/proposals/{proposal}/accept

Écriture guide.proposals.accept

Paramètres

ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).
proposal chemin: Identifiant (ULID).

Corps application/json

keys array<string> requis

éléments : au moins 1
edits array<array<object>>
edits[].title string

longueur : au plus 255
edits[].requirement object

une valeur parmi mandatory optional
edits[].depth object

une valeur parmi overview standard deep

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/guide/{ownerType}/{ownerId}/proposals/{proposal}/accept" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"keys":[]}'

POST /guide/{ownerType}/{ownerId}/propose-topics

Écriture guide.propose-topics

Paramètres

ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).

Corps application/json

count integer

au moins 3 au plus 12
focus string | null

longueur : au plus 1000
locale string | null

une valeur parmi en fr

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/guide/{ownerType}/{ownerId}/propose-topics" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"count":3,"focus":"…","locale":"en"}'

GET /guide/{ownerType}/{ownerId}/topics

Lecture guide.topics.index

Paramètres

ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId 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/guide/{ownerType}/{ownerId}/topics" \
  -H "Authorization: Bearer pat_…"

POST /guide/{ownerType}/{ownerId}/topics

Écriture guide.topics.store

Paramètres

ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).

Corps application/json

key string | null
title string requis

longueur : au plus 255
description string | null

longueur : au plus 4000
requirement object

une valeur parmi mandatory optional
depth object

une valeur parmi overview standard deep
opening_questions array<string>

éléments : au plus 20
information_targets array<object>

éléments : au plus 20
information_targets[].key string requis
information_targets[].label string requis

longueur : au plus 255
demonstrations array<string>

éléments : au plus 20
forbidden_subjects array<string>

éléments : au plus 20
deliverable_category string | null

longueur : au plus 64
position integer

au moins 0

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/guide/{ownerType}/{ownerId}/topics" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"title":"…"}'

POST /guide/{ownerType}/{ownerId}/topics/reorder

Écriture guide.topics.reorder

Paramètres

ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).

Corps application/json

ids array<string> requis

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/guide/{ownerType}/{ownerId}/topics/reorder" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"ids":[]}'

PATCH /guide/{ownerType}/{ownerId}/topics/{topic}

Écriture guide.topics.update

Paramètres

ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).
topic chemin: Identifiant (ULID).

Corps application/json

key string | null
title string

longueur : au plus 255
description string | null

longueur : au plus 4000
requirement object

une valeur parmi mandatory optional
depth object

une valeur parmi overview standard deep
opening_questions array<string>

éléments : au plus 20
information_targets array<object>

éléments : au plus 20
information_targets[].key string requis
information_targets[].label string requis

longueur : au plus 255
demonstrations array<string>

éléments : au plus 20
forbidden_subjects array<string>

éléments : au plus 20
deliverable_category string | null

longueur : au plus 64
position integer

au moins 0

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/guide/{ownerType}/{ownerId}/topics/{topic}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"key":"…","title":"…","description":"…"}'

DELETE /guide/{ownerType}/{ownerId}/topics/{topic}

Écriture guide.topics.destroy

Paramètres

ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).
topic chemin: Identifiant (ULID).

Réponses

204 Supprimé, sans contenu.
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 DELETE "https://{votre-espace}.tellmehow.io/api/v1/guide/{ownerType}/{ownerId}/topics/{topic}" \
  -H "Authorization: Bearer pat_…"

GET /methods

Lecture methods.index

Paramètres

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/methods" \
  -H "Authorization: Bearer pat_…"

POST /methods

Écriture methods.store

Corps application/json

name string requis

longueur : au plus 255
description string | null

longueur : au plus 2000

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/methods" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

GET /methods/enums/avatar-presets

Lecture methods.enums.avatar-presets

Paramètres

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/methods/enums/avatar-presets" \
  -H "Authorization: Bearer pat_…"

GET /methods/enums/{name}

Lecture methods.enums.show

Paramètres

name 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/methods/enums/{name}" \
  -H "Authorization: Bearer pat_…"

POST /methods/from-template

Écriture methods.from-template

Corps application/json

template_key string requis
name string | null

longueur : au plus 255
locale string | null

une valeur parmi en fr

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/methods/from-template" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"template_key":"…"}'

GET /methods/templates

Lecture methods.templates.index

Paramètres

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/methods/templates" \
  -H "Authorization: Bearer pat_…"

GET /methods/{method}

Lecture methods.show

Paramètres

method 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/methods/{method}" \
  -H "Authorization: Bearer pat_…"

PATCH /methods/{method}

Écriture methods.update

Paramètres

method chemin: Identifiant (ULID).

Corps application/json

name string requis

longueur : au plus 255
description string | null

longueur : au plus 2000

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/methods/{method}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

DELETE /methods/{method}

Écriture methods.destroy

Paramètres

method chemin: Identifiant (ULID).

Réponses

204 Supprimé, sans contenu.
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 DELETE "https://{votre-espace}.tellmehow.io/api/v1/methods/{method}" \
  -H "Authorization: Bearer pat_…"

POST /methods/{method}/duplicate

Écriture methods.duplicate

Paramètres

method 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/methods/{method}/duplicate" \
  -H "Authorization: Bearer pat_…"

GET /methods/{method}/versions

Lecture methods.versions.index

Paramètres

method 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/methods/{method}/versions" \
  -H "Authorization: Bearer pat_…"

GET /methods/{method}/versions/{version}

Lecture methods.versions.show

Paramètres

method chemin: Identifiant (ULID).
version 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/methods/{method}/versions/{version}" \
  -H "Authorization: Bearer pat_…"

PATCH /methods/{method}/versions/{version}

Écriture methods.versions.update

Paramètres

method chemin: Identifiant (ULID).
version chemin: Identifiant (ULID).

Corps application/json

objectives string | null

longueur : au plus 10000
interviewer_instructions string | null

longueur : au plus 10000
posture array<object>
posture.register array<object>

une valeur parmi vous tu neutral
posture.use_first_name boolean
posture.formality object

une valeur parmi relaxed standard formal
posture.warmth object

une valeur parmi reserved standard warm
posture.probing object

une valeur parmi light standard insistent
posture.silence_threshold_ms integer

au moins 400 au plus 5000
posture.allow_suggestions boolean
persona array<object>
persona.name string requis

longueur : au plus 60
persona.avatar_preset object

une valeur parmi classic short_hair glasses curly bun beard
persona.voice string | null

longueur : au plus 128
welcome_screen array<array<object>>
welcome_screen[].title string | null

longueur : au plus 255
welcome_screen[].intro string | null

longueur : au plus 2000
welcome_screen[].accept_label string | null

longueur : au plus 255
welcome_screen[].highlights array<string | null>

éléments : au plus 6
welcome_screen[].blocks array<object>
welcome_screen[].blocks.custom array<object>

éléments : au plus 6
welcome_screen[].blocks.custom[].title string | null

longueur : au plus 255
welcome_screen[].blocks.custom[].body string | null

longueur : au plus 4000
welcome_screen[].blocks[].title string | null

longueur : au plus 255
welcome_screen[].blocks[].body string | null

longueur : au plus 4000
deliverable_schema array<object>
deliverable_schema.sections array<object>
deliverable_schema.sections[].key object requis

une valeur parmi summary process_map findings contradictions opportunities recommendations tools
deliverable_schema.sections[].enabled boolean requis
deliverable_schema.finding_categories array<object>

éléments : au plus 30
deliverable_schema.finding_categories[].key string requis
deliverable_schema.finding_categories[].label array<string | null> requis
deliverable_schema.finding_categories[].description array<string | null>
deliverable_schema.opportunity_categories array<object>

éléments : au plus 30
deliverable_schema.opportunity_categories[].key string requis
deliverable_schema.opportunity_categories[].label array<string | null> requis
deliverable_schema.opportunity_categories[].description array<string | null>
deliverable_schema.priority_scale array<object>

éléments : au plus 6
deliverable_schema.priority_scale[].key string requis

longueur : au plus 32
deliverable_schema.priority_scale[].label array<string | null> requis
deliverable_schema.priority_scale[].rule string requis

longueur : au plus 255

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/methods/{method}/versions/{version}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"objectives":"…","interviewer_instructions":"…","posture":[]}'

POST /methods/{method}/versions/{version}/draft

Écriture methods.versions.draft

Paramètres

method chemin: Identifiant (ULID).
version 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/methods/{method}/versions/{version}/draft" \
  -H "Authorization: Bearer pat_…"

POST /methods/{method}/versions/{version}/persona/avatar

Écriture methods.versions.avatar

Paramètres

method chemin: Identifiant (ULID).
version chemin: Identifiant (ULID).

Corps multipart/form-data

avatar file requis

longueur : au plus 2048

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/methods/{method}/versions/{version}/persona/avatar" \
  -H "Authorization: Bearer pat_…" \
  -F "avatar=@./file.pdf"

POST /methods/{method}/versions/{version}/publish

Écriture methods.versions.publish

Paramètres

method chemin: Identifiant (ULID).
version 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/methods/{method}/versions/{version}/publish" \
  -H "Authorization: Bearer pat_…"