API pro rozhovory

Rozhovor je jedno sezení AI s jedním respondentem. API vrací, kdo je respondent, shrnutí od AI s jednou odpovědí na každou otázku a celý přepis. Ověření, stránkování a chyby popisuje Přehled API.

Výpis rozhovorů#

HTTP

GET /api/v1/projects/{project_id}/conversations

Vrátí rozhovory projektu od nejnovějších, každý se shrnutím od AI. Přepisy ve výpisu nejsou. Získáte je přes Načtení rozhovoru.

Parametry dotazu#

Parametr	Popis
`status`	Jedna nebo více hodnot `invited`, `opened`, `started`, `completed`, `cancelled`, oddělených čárkami. Bez něj se vracejí všechny stavy kromě `invited`.
`sentiment`	Jedna nebo více hodnot `positive`, `negative`, `neutral`, `mixed`, oddělených čárkami
`created_after`	Jen rozhovory vytvořené v tomto čase ISO 8601 nebo po něm, například `2026-05-01T00:00:00Z`
`created_before`	Jen rozhovory vytvořené v tomto čase nebo před ním
`search`	Text, který se hledá ve shrnutích, citacích a údajích o respondentovi. Nejvýš 200 znaků.
`limit`	1 až 100. Výchozí `25`.
`cursor`	Hodnota `next_cursor` z předchozí stránky

Úplné shrnutí mají jen dokončené rozhovory, proto většina integrací posílá status=completed.

Příklad#

curl -G "https://diaform.io/api/v1/projects/b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d/conversations" \
  -H "Authorization: Bearer $DIAFORM_API_KEY" \
  --data-urlencode "status=completed" \
  --data-urlencode "sentiment=negative,mixed" \
  --data-urlencode "created_after=2026-05-01T00:00:00Z" \
  --data-urlencode "limit=50"

Odpověď#

JSON

{
  "data": [
    {
      "id": "0f8d43a2-6df9-49c8-bf5d-fd2b6ec2d9ee",
      "project_id": "b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
      "status": "completed",
      "created_at": "2026-05-07T12:00:00.123456+00:00",
      "started_at": "2026-05-07T12:01:11.482913+00:00",
      "ended_at": "2026-05-07T12:15:41.204+00:00",
      "duration_seconds": 870,
      "country": "DE",
      "overall_sentiment": "mixed",
      "respondent": {
        "label": "alex@acme.com",
        "email": null,
        "identities": [
          { "type": "email", "value": "alex@acme.com", "source": "owner" },
          { "type": "name", "value": "Alex", "source": "ai" }
        ]
      },
      "metadata": {},
      "invite": {
        "id": "3a4f49c7-b8f4-4c44-8f74-fd8e4277c3e4",
        "status": "completed",
        "created_at": "2026-05-07T12:00:00.123456+00:00",
        "opened_at": "2026-05-07T12:01:11.482913+00:00",
        "completed_at": "2026-05-07T12:15:41.204+00:00"
      },
      "summary": {
        "overall_sentiment": "mixed",
        "answers": [
          {
            "question_id": "V1StGXR8_Z5jdHi6B-myT",
            "question": "How did your first week with the product go?",
            "summary": "Setup was quick, but inviting teammates was confusing.",
            "sentiment": "mixed",
            "confidence": "high",
            "quotes": ["I had no idea where the invite button was"]
          }
        ],
        "urgent_issues": [],
        "additional_insights": "Would pay more for a Slack integration."
      }
    }
  ],
  "has_more": true,
  "next_cursor": "WyIyMDI2LTA1LTA3VDEyOjAwOjAwLjEyMzQ1NiswMDowMCIsIjBmOGQ0M2EyIl0"
}

Pole rozhovoru#

Pole	Typ	Popis
`id`	string	ID rozhovoru, stejné, jaké webhooky posílají jako `conversation_id`
`project_id`	string	Projekt, ke kterému patří
`status`	string	`invited`, `opened`, `started`, `completed` nebo `cancelled`. Dashboard ukazuje `started` jako Probíhá.
`created_at`	string	Kdy byl rozhovor vytvořen. U pozvánek je to okamžik vytvoření pozvánky.
`started_at`	string nebo null	Kdy rozhovor začal
`ended_at`	string nebo null	Kdy byl rozhovor dokončen nebo zrušen
`duration_seconds`	number nebo null	Doba od začátku do konce
`country`	string nebo null	Kód země respondenta, pokud je známý
`overall_sentiment`	string nebo null	`positive`, `negative`, `neutral` nebo `mixed`. Stejné jako `summary.overall_sentiment`.
`respondent.label`	string nebo null	Nejlepší označení respondenta: e-mail, potom jméno, potom jiná identita
`respondent.email`	string nebo null	Starší pole, u nových rozhovorů `null`. E-maily čtěte z `respondent.identities`.
`respondent.identities`	array	Vše, co je o respondentovi známo. `source` je `owner` (zadali jste ji vy), `ai` (vytažená ze zpráv respondenta) nebo `system` (přidaná systémem Diaform).
`metadata`	object	U pozvánek a přímých odkazů prázdné. U vložených rozhovorů obsahuje údaje o vložení, například `"embed": true` a `embed_parent_origin`.
`invite`	object nebo null	Údaje o pozvánce, pokud rozhovor vznikl z pozvánky respondenta, jinak `null`
`summary`	object nebo null	Shrnutí od AI. `null`, dokud rozhovor neskončí a shrnutí není hotové.

Pole shrnutí#

Pole	Typ	Popis
`overall_sentiment`	string	`positive`, `negative`, `neutral` nebo `mixed`
`answers`	array	Jedna položka na každou otázku, kterou respondent dostal
`answers[].question_id`	string	ID otázky v projektu
`answers[].question`	string	Otázka tak, jak byla položena
`answers[].summary`	string	Krátké shrnutí odpovědi
`answers[].sentiment`	string	`positive`, `negative`, `neutral` nebo `mixed`
`answers[].confidence`	string	`high`, `medium` nebo `low`: jak úplně byla otázka zodpovězena
`answers[].quotes`	array	Výrazné citace vlastními slovy respondenta. Často prázdné.
`urgent_issues`	array	Kritické problémy, které respondent zmínil, jako krátké řetězce
`additional_insights`	string nebo null	Užitečná zpětná vazba, která nepatřila k žádné otázce

Načtení rozhovoru#

HTTP

GET /api/v1/conversations/{conversation_id}

Vrátí jeden rozhovor se všemi poli z výpisu a navíc s přepisem v messages.

Příklad#

curl "https://diaform.io/api/v1/conversations/0f8d43a2-6df9-49c8-bf5d-fd2b6ec2d9ee" \
  -H "Authorization: Bearer $DIAFORM_API_KEY"

Odpověď#

Pole společná s výpisem jsou tady zkrácená.

JSON

{
  "id": "0f8d43a2-6df9-49c8-bf5d-fd2b6ec2d9ee",
  "project_id": "b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
  "status": "completed",
  "overall_sentiment": "mixed",
  "summary": {},
  "messages": [
    {
      "role": "interviewer",
      "text": "Hi! Thanks for taking the time. How did your first week with the product go?"
    },
    {
      "role": "respondent",
      "text": "Setup was fast. But I had no idea where the invite button was."
    },
    {
      "role": "interviewer",
      "text": "Where did you expect to find it?"
    }
  ]
}

Pole	Typ	Popis
`messages`	array	Přepis v pořadí zpráv. Prázdný, pokud respondent vůbec neodpověděl.
`messages[].role`	string	`interviewer` (AI) nebo `respondent`
`messages[].text`	string	Co zaznělo. Mluvené odpovědi jsou uvedené jako přepis řeči a výběr nebo hodnocení jako text, například `Selected answers: Pro`.