Twins

Basis-URL: https://app.neuroflash.com/api/digital-twin-service

Rufen Sie einzelne digitale Zwillingspersonen aus statischen Gruppen ab.

Statische Gruppe Twins auflisten

GET/v1/workspaces/{workspace_id}/static-groups/{group_key}/twins

Alle Twins in einer statischen Gruppe mit Pagination auflisten.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`group_key`	string	Ja	Der Schlüssel der statischen Gruppe (z. B. gen_z, millennials)

Abfrageparameter

Parameter	Typ	Standard	Beschreibung
`page`	integer	`1`	Seitennummer (1-basiert)
`size`	integer	`20`	Anzahl der Elemente pro Seite
`order`	string	—	Sortierreihenfolge nach Name
`twinIds`	string	—	Kommagetrennte Liste von Twin-IDs zum Filtern

Antwort

dataarray<object>Liste der Twins für diese Seite

idstringEindeutige Kennung

createdAtstringZeitstempel der Erstellung des Datensatzes

updatedAtstringZeitstempel der letzten Aktualisierung des Datensatzes

createdByUserIdobjectID des Benutzers, der diesen Datensatz erstellt hat

targetAudienceIdobjectZielgruppen-ID (entweder diese oder staticGroupKey muss gesetzt sein)

staticGroupKeyobjectSchlüssel der zugehörigen statischen Gruppe (entweder dieser oder targetAudienceId muss gesetzt sein)

subjectIdstringID des Subjekts, auf dem dieser Twin basiert

namestringVollständiger Name des Digital Twin

titleobjectAussagekräftiger Titel für den Digital Twin

ageobjectAlter des Digital Twin

genderobjectGeschlecht des Digital Twin

locationobjectStandort des Digital Twin

jobTitleobjectBerufsbezeichnung des Digital Twin

selfDescriptionobjectSelbstbeschreibung des Digital Twin aus Umfrageantworten

_linksobjectHATEOAS-Links (z. B. avatarUrl)

pageobjectPagination-Metadaten.

sizeintegerAnzahl der Elemente pro Seite

totalElementsintegerGesamtanzahl der übereinstimmenden Elemente

totalPagesintegerGesamtanzahl der Seiten

currentPageintegerAktuelle Seitennummer (1-basiert)

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/static-groups/{group_key}/twins" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/static-groups/{group_key}/twins",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/${workspaceId}/static-groups/${groupKey}/twins`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/"+workspaceID+"/static-groups/"+groupKey+"/twins", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "createdByUserId": "12345",
      "targetAudienceId": "aud_12345",
      "staticGroupKey": "millennials",
      "subjectId": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Jens Bauer",
      "title": "Tech-Savvy Millennial",
      "age": 28,
      "gender": "Male",
      "location": "Berlin, Germany",
      "jobTitle": "Software Engineer",
      "selfDescription": "I'm a tech enthusiast who loves innovation and problem-solving.",
      "_links": {}
    }
  ],
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "currentPage": 0
  }
}

Mit Twin chatten

POST/v1/workspaces/{workspace_id}/twins/{twin_id}/chat-completions

Mit einem digitalen Zwilling mit Gesprächskontext chatten.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspace_id`	string	Ja
`twin_id`	string	Ja

Anfrage-Body

messagesarray<object>JaGesprächsverlauf

rolestringJaRolle: „user" oder „assistant"

contentstringJaNachrichteninhalt

responseFormatobjectNeinStrukturiertes Ausgabeformat mit JSON-Schema. Falls null, verwendet Standard-Schema mit Feldern „answer" und „reason".

temperatureobjectNeinSampling-Temperatur für Antwortgenerierung

useWebSearchobjectNeinWebsuch-Modus: „never", „auto" oder „always"

useVerbalizedSamplingobjectNein5 wahrscheinlichkeitsgewichtete Antwortoptionen generieren (tau=0,10). Gegenseitig ausschließlich mit benutzerdefiniertem responseFormat.

Beispiel

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/twins/{twin_id}/chat-completions" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "messages": [],
      "responseFormat": {},
      "temperature": {},
      "useWebSearch": {},
      "useVerbalizedSampling": {}
  }'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/twins/{twin_id}/chat-completions",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "messages": [],
        "responseFormat": {},
        "temperature": {},
        "useWebSearch": {},
        "useVerbalizedSampling": {}
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/${workspaceId}/twins/${twinId}/chat-completions`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "messages": [],
          "responseFormat": {},
          "temperature": {},
          "useWebSearch": {},
          "useVerbalizedSampling": {}
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"messages": []any{},
		"responseFormat": map[string]any{},
		"temperature": map[string]any{},
		"useWebSearch": map[string]any{},
		"useVerbalizedSampling": map[string]any{},
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/"+workspaceID+"/twins/"+twinID+"/chat-completions", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{}

Digitalen Zwilling abrufen

GET/v1/workspaces/{workspace_id}/twins/{twin_id}

Rufen Sie einen einzelnen digitalen Zwilling nach ID ab.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspace_id`	string	Ja	Die Workspace-ID
`twin_id`	string	Ja	Die zu abzurufende Twin-ID

Antwort

idstringEindeutige Kennung

createdAtstringZeitstempel der Erstellung des Datensatzes

updatedAtstringZeitstempel der letzten Aktualisierung des Datensatzes

createdByUserIdobjectID des Benutzers, der diesen Datensatz erstellt hat

targetAudienceIdobjectZielgruppen-ID (entweder diese oder staticGroupKey muss gesetzt sein)

staticGroupKeyobjectSchlüssel der zugehörigen statischen Gruppe (entweder dieser oder targetAudienceId muss gesetzt sein)

subjectIdstringID des Subjekts, auf dem dieser Twin basiert

namestringVollständiger Name des Digital Twin

titleobjectAussagekräftiger Titel für den Digital Twin

ageobjectAlter des Digital Twin

genderobjectGeschlecht des Digital Twin

locationobjectStandort des Digital Twin

jobTitleobjectBerufsbezeichnung des Digital Twin

selfDescriptionobjectSelbstbeschreibung des Digital Twin aus Umfrageantworten

_linksobjectHATEOAS-Links (z. B. avatarUrl)

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/twins/{twin_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/{workspace_id}/twins/{twin_id}",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/${workspaceId}/twins/${twinId}`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/digital-twin-service/v1/workspaces/"+workspaceID+"/twins/"+twinID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "createdByUserId": "12345",
  "targetAudienceId": "aud_12345",
  "staticGroupKey": "millennials",
  "subjectId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Jens Bauer",
  "title": "Tech-Savvy Millennial",
  "age": 28,
  "gender": "Male",
  "location": "Berlin, Germany",
  "jobTitle": "Software Engineer",
  "selfDescription": "I'm a tech enthusiast who loves innovation and problem-solving.",
  "_links": {}
}

Statische Gruppe Twins auflisten​

Pfadparameter​

Abfrageparameter​

Antwort​

Beispiel​

Mit Twin chatten​

Pfadparameter​

Anfrage-Body​

Beispiel​

Digitalen Zwilling abrufen​

Pfadparameter​

Antwort​

Beispiel​

Statische Gruppe Twins auflisten

Pfadparameter

Abfrageparameter

Antwort

Beispiel

Mit Twin chatten

Pfadparameter

Anfrage-Body

Beispiel

Digitalen Zwilling abrufen

Pfadparameter

Antwort

Beispiel