Projekt-API

Et projekt er én AI-interviewer med egne spørgsmål. De fleste andre endpoints kræver et projekt-ID, så dette er som regel det første kald, du laver. Se API-overblikket for godkendelse, paginering og fejl.

Vis projekter#

HTTP

GET /api/v1/projects

Returnerer alle projekter i nøglens organisation, nyeste først, uanset om de er udgivet eller ej. Endpointet tager ingen parametre og returnerer alle projekter på én side.

Eksempel#

curl "https://diaform.io/api/v1/projects" \
  -H "Authorization: Bearer $DIAFORM_API_KEY"

Svar#

JSON

{
  "data": [
    {
      "id": "b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
      "name": "Onboarding interviews",
      "product_name": "Acme",
      "published": true,
      "language": "english",
      "respondent_access": "public",
      "url": "https://acme.diaform.io/c/b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
      "created_at": "2026-04-02T09:14:31.402057+00:00",
      "published_at": "2026-04-02T09:41:05.471073+00:00"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Felter for projekter#

Felt	Type	Beskrivelse
`id`	string	Projekt-ID
`name`	string eller null	Projektets navn, som det vises i dashboardet
`product_name`	string eller null	Produkt- eller servicenavn fra projektets indstillinger
`published`	boolean	Om projektet er live
`language`	string eller null	Interviewets sprog, f.eks. `english`
`respondent_access`	string	`public` (alle med linket) eller `invite_only`
`url`	string eller null	Det offentlige samtalelink. Det bruger dit verificerede egne domæne, hvis du har et.
`created_at`	string	Hvornår projektet blev oprettet
`published_at`	string eller null	Hvornår det sidst blev udgivet

Hent et projekt#

HTTP

GET /api/v1/projects/{project_id}

Returnerer ét projekt med dets aktuelle spørgsmål og antal samtaler.

Eksempel#

curl "https://diaform.io/api/v1/projects/b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d" \
  -H "Authorization: Bearer $DIAFORM_API_KEY"

Svar#

JSON

{
  "id": "b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
  "name": "Onboarding interviews",
  "product_name": "Acme",
  "published": true,
  "language": "english",
  "respondent_access": "public",
  "url": "https://acme.diaform.io/c/b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
  "created_at": "2026-04-02T09:14:31.402057+00:00",
  "published_at": "2026-04-02T09:41:05.471073+00:00",
  "questions": [
    {
      "id": "V1StGXR8_Z5jdHi6B-myT",
      "text": "How did your first week with the product go?",
      "type": "open_text",
      "required": false,
      "options": []
    },
    {
      "id": "tTJUuhijB3m3nvA5horJ6",
      "text": "Which plan are you on?",
      "type": "single_choice",
      "required": true,
      "options": [
        { "id": "fvbfMZcZXZLzZWCa-jXXJ", "label": "Starter" },
        { "id": "nb-XqVVvSICqEQjZ12Mox", "label": "Pro" }
      ]
    }
  ],
  "conversation_counts": {
    "total": 212,
    "completed": 148
  }
}

Svaret har alle felter fra listen samt:

Felt	Type	Beskrivelse
`questions`	array	De udgivne spørgsmål i rækkefølge
`questions[].id`	string	Spørgsmålets ID. Samtalernes opsummeringer henviser til det som `question_id`.
`questions[].text`	string	Spørgsmålet, som det er skrevet
`questions[].type`	string	`open_text`, `single_choice`, `multiple_choice`, `nps`, `star_rating` eller `file_upload`
`questions[].required`	boolean	Om spørgsmålet er påkrævet
`questions[].options`	array	Valgmulighederne i et valgspørgsmål, hver med `id` og `label`. Tom for andre typer.
`conversation_counts.total`	number	Samtaler, der som minimum blev åbnet
`conversation_counts.completed`	number	Samtaler, der nåede til ende

Spørgsmål kan ændre sig over tid. En samtales opsummering beholder den formulering, respondenten faktisk fik stillet.