Samtale-API

En samtale er ét interview mellem AI'en og én respondent. API'et returnerer, hvem respondenten er, AI-opsummeringen med ét svar pr. spørgsmål og hele transskriptionen. Se API-overblikket for godkendelse, paginering og fejl.

Vis samtaler#

HTTP

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

Returnerer et projekts samtaler, nyeste først, hver med sin AI-opsummering. Transskriptioner er ikke med i listen. Hent dem med Hent en samtale.

Query-parametre#

Parameter	Beskrivelse
`status`	En eller flere af `invited`, `opened`, `started`, `completed`, `cancelled`, adskilt af kommaer. Uden den returneres alle statusser undtagen `invited`.
`sentiment`	En eller flere af `positive`, `negative`, `neutral`, `mixed`, adskilt af kommaer
`created_after`	Kun samtaler, der er oprettet på eller efter dette ISO 8601-tidspunkt, f.eks. `2026-05-01T00:00:00Z`
`created_before`	Kun samtaler, der er oprettet på eller før dette tidspunkt
`search`	Tekst, der søges efter i opsummeringer, citater og oplysninger om respondenten. Op til 200 tegn.
`limit`	1 til 100. Standard `25`.
`cursor`	`next_cursor` fra den forrige side

Kun gennemførte samtaler har en fuld opsummering, så de fleste integrationer sender status=completed.

Eksempel#

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"

Svar#

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"
}

Felter for samtaler#

Felt	Type	Beskrivelse
`id`	string	Samtalens ID, det samme, som webhooks sender som `conversation_id`
`project_id`	string	Det projekt, den hører til
`status`	string	`invited`, `opened`, `started`, `completed` eller `cancelled`. Dashboardet viser `started` som I gang.
`created_at`	string	Hvornår samtalen blev oprettet. For invitationer er det tidspunktet, hvor invitationen blev oprettet.
`started_at`	string eller null	Hvornår interviewet startede
`ended_at`	string eller null	Hvornår samtalen blev gennemført eller annulleret
`duration_seconds`	number eller null	Tiden fra start til slut
`country`	string eller null	Respondentens landekode, hvis den kendes
`overall_sentiment`	string eller null	`positive`, `negative`, `neutral` eller `mixed`. Det samme som `summary.overall_sentiment`.
`respondent.label`	string eller null	Det bedste navn for respondenten: e-mailen, derefter navnet, derefter en anden identitet
`respondent.email`	string eller null	Forældet felt, `null` for nye samtaler. Læs e-mails fra `respondent.identities`.
`respondent.identities`	array	Alt, hvad der vides om respondenten. `source` er `owner` (du har leveret den), `ai` (udtrukket fra respondentens beskeder) eller `system` (tilføjet af Diaform).
`metadata`	object	Tom for invitationer og direkte links. For indlejrede samtaler indeholder den detaljer om indlejringen, f.eks. `"embed": true` og `embed_parent_origin`.
`invite`	object eller null	Detaljer om invitationen, når samtalen kom fra en respondentinvitation, ellers `null`
`summary`	object eller null	AI-opsummeringen. `null`, indtil samtalen slutter, og opsummeringen er klar.

Felter for opsummeringen#

Felt	Type	Beskrivelse
`overall_sentiment`	string	`positive`, `negative`, `neutral` eller `mixed`
`answers`	array	Én post pr. spørgsmål, respondenten fik stillet
`answers[].question_id`	string	Spørgsmålets ID i projektet
`answers[].question`	string	Spørgsmålet, som det blev stillet
`answers[].summary`	string	En kort opsummering af svaret
`answers[].sentiment`	string	`positive`, `negative`, `neutral` eller `mixed`
`answers[].confidence`	string	`high`, `medium` eller `low`: hvor fuldt spørgsmålet blev besvaret
`answers[].quotes`	array	Udvalgte citater med respondentens egne ord. Ofte tom.
`urgent_issues`	array	Kritiske problemer, respondenten har nævnt, som korte strenge
`additional_insights`	string eller null	Nyttig feedback, der ikke hørte til et bestemt spørgsmål

Hent en samtale#

HTTP

GET /api/v1/conversations/{conversation_id}

Returnerer én samtale med alle felter fra listen samt transskriptionen i messages.

Eksempel#

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

Svar#

De felter, der også findes i listen, er forkortet her.

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?"
    }
  ]
}

Felt	Type	Beskrivelse
`messages`	array	Transskriptionen i rækkefølge. Tom, når respondenten aldrig svarede.
`messages[].role`	string	`interviewer` (AI'en) eller `respondent`
`messages[].text`	string	Det, der blev sagt. Talte svar vises som transskription, og et valg eller en bedømmelse vises som tekst, f.eks. `Selected answers: Pro`.