Zum Hauptinhalt springen

Zielgruppen

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

Erstellen und verwalten Sie Zielgruppenprofil fĂŒr Ihren Arbeitsbereich.

Erstelle eine neue Zielgruppe​

POST/v1/workspaces/{workspaceId}/target-audiences

Erstellt eine neue Zielgruppe fĂŒr den angegebenen Arbeitsbereich

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID

Anfrage-Body​

FeldTypErforderlichBeschreibung
additionalInformationstringNein
countrystringNein
genderDistributionobjectJa
femalenumberJa
malenumberJa
nonBinarynumberJa
preferNotToSaynumberJa
interestsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
maxAgeintegerJa
minAgeintegerJaWir speichern den Altersbereich als separate Min-/Max-Felder in der Datenbank
namestringJa
nativeLanguagestringNein
needsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
painPointsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
residencestringJa

Antwort​

FeldTypBeschreibung
_embeddedobject
createdByCustomerobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
imageobjectEin Bild, das einer Zielgruppe zugeordnet ist
createdAtstring
createdByUserIdstring
fileNamestringFileName wird zum Generieren eines SpeicherschlĂŒssels verwendet, der bei VervielfĂ€ltigung auch mit dem Dateinamen endet
idstring
targetAudienceIdstring
updatedAtstring
urlstring
newPermissionsobject
deletionAllowedboolean
duplicationAllowedboolean
updateAllowedboolean
viewingAllowedboolean
permissionsobject
canDeleteboolean
canDuplicateboolean
canUpdateboolean
canViewboolean
additionalInformationstring
countrystring
createdAtstring
createdByUserIdstring
genderDistributionobject
femalenumber
malenumber
nonBinarynumber
preferNotToSaynumber
idstring
interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
maxAgeinteger
minAgeintegerWir speichern den Altersbereich als separate Min-/Max-Felder in der Datenbank
namestring
nativeLanguagestring
needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
residencestring
summarystringSummary ist der gerenderte Prosa-Text, der in nachgelagerte Prompts eingegeben wird (Chat, Prompt-LĂ€ufe usw.). Wird ĂŒber die API fĂŒr das Frontend in Chat usw. serialisiert
updatedAtstring
viewedAtstring
workspaceIdstring

Beispiel​

curl -X POST "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"additionalInformation": "string",
"country": "string",
"genderDistribution": {},
"interests": [],
"maxAge": 0,
"minAge": 0,
"name": "string",
"nativeLanguage": "string",
"needs": [],
"painPoints": [],
"residence": "string"
}'

Antwort:

{
"_embedded": {
"createdByCustomer": {
"email": "eren.jaeger@neuroflash.com",
"hadTrial": false,
"legacyId": 5,
"name": "Eren Jaeger"
},
"image": {
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"fileName": "string",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"targetAudienceId": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
},
"newPermissions": {
"deletionAllowed": true,
"duplicationAllowed": true,
"updateAllowed": true,
"viewingAllowed": true
},
"permissions": {
"canDelete": false,
"canDuplicate": false,
"canUpdate": false,
"canView": false
}
},
"additionalInformation": "This audience prefers short-form video content",
"country": "US",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"genderDistribution": {
"female": 0.5,
"male": 0.5,
"nonBinary": 0.5,
"preferNotToSay": 0.5
},
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"interests": [
"string"
],
"maxAge": 65,
"minAge": 18,
"name": "Young urban professionals",
"nativeLanguage": "de",
"needs": [
"string"
],
"painPoints": [
"string"
],
"residence": "Berlin",
"summary": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"viewedAt": "2025-01-14T16:20:59Z",
"workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
}

Create duplication​

POST/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/duplication

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID
targetAudienceIdstringJaZielgruppen-ID

Anfrage-Body​

FeldTypErforderlichBeschreibung
newNamestringNein

Antwort​

FeldTypBeschreibung
duplicateobjectEine Zielgruppe ist eine Gruppe von Personen, die gemeinsame Eigenschaften teilen, und Inhalte können auf sie ausgerichtet werden
_embeddedobject
createdByCustomerobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
imageobjectEin Bild, das einer Zielgruppe zugeordnet ist
createdAtstring
createdByUserIdstring
fileNamestringFileName wird zum Generieren eines SpeicherschlĂŒssels verwendet, der bei VervielfĂ€ltigung auch mit dem Dateinamen endet
idstring
targetAudienceIdstring
updatedAtstring
urlstring
newPermissionsobject
deletionAllowedboolean
duplicationAllowedboolean
updateAllowedboolean
viewingAllowedboolean
permissionsobject
canDeleteboolean
canDuplicateboolean
canUpdateboolean
canViewboolean
additionalInformationstring
countrystring
createdAtstring
createdByUserIdstring
genderDistributionobject
femalenumber
malenumber
nonBinarynumber
preferNotToSaynumber
idstring
interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
maxAgeinteger
minAgeintegerWir speichern den Altersbereich als separate Min-/Max-Felder in der Datenbank
namestring
nativeLanguagestring
needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
residencestring
summarystringSummary ist der gerenderte Prosa-Text, der in nachgelagerte Prompts eingegeben wird (Chat, Prompt-LĂ€ufe usw.). Wird ĂŒber die API fĂŒr das Frontend in Chat usw. serialisiert
updatedAtstring
viewedAtstring
workspaceIdstring
originalobjectEine Zielgruppe ist eine Gruppe von Personen, die gemeinsame Eigenschaften teilen, und Inhalte können auf sie ausgerichtet werden
_embeddedobject
createdByCustomerobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
imageobjectEin Bild, das einer Zielgruppe zugeordnet ist
createdAtstring
createdByUserIdstring
fileNamestringFileName wird zum Generieren eines SpeicherschlĂŒssels verwendet, der bei VervielfĂ€ltigung auch mit dem Dateinamen endet
idstring
targetAudienceIdstring
updatedAtstring
urlstring
newPermissionsobject
deletionAllowedboolean
duplicationAllowedboolean
updateAllowedboolean
viewingAllowedboolean
permissionsobject
canDeleteboolean
canDuplicateboolean
canUpdateboolean
canViewboolean
additionalInformationstring
countrystring
createdAtstring
createdByUserIdstring
genderDistributionobject
femalenumber
malenumber
nonBinarynumber
preferNotToSaynumber
idstring
interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
maxAgeinteger
minAgeintegerWir speichern den Altersbereich als separate Min-/Max-Felder in der Datenbank
namestring
nativeLanguagestring
needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
residencestring
summarystringSummary ist der gerenderte Prosa-Text, der in nachgelagerte Prompts eingegeben wird (Chat, Prompt-LĂ€ufe usw.). Wird ĂŒber die API fĂŒr das Frontend in Chat usw. serialisiert
updatedAtstring
viewedAtstring
workspaceIdstring

Beispiel​

curl -X POST "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/duplication" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"newName": "string"
}'

Antwort:

{
"duplicate": {
"_embedded": {
"createdByCustomer": {
"email": "eren.jaeger@neuroflash.com",
"hadTrial": false,
"legacyId": 5,
"name": "Eren Jaeger"
},
"image": {
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"fileName": "string",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"targetAudienceId": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
},
"newPermissions": {
"deletionAllowed": true,
"duplicationAllowed": true,
"updateAllowed": true,
"viewingAllowed": true
},
"permissions": {
"canDelete": false,
"canDuplicate": false,
"canUpdate": false,
"canView": false
}
},
"additionalInformation": "This audience prefers short-form video content",
"country": "US",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"genderDistribution": {
"female": 0.5,
"male": 0.5,
"nonBinary": 0.5,
"preferNotToSay": 0.5
},
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"interests": [
"string"
],
"maxAge": 65,
"minAge": 18,
"name": "Young urban professionals",
"nativeLanguage": "de",
"needs": [
"string"
],
"painPoints": [
"string"
],
"residence": "Berlin",
"summary": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"viewedAt": "2025-01-14T16:20:59Z",
"workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
},
"original": {
"_embedded": {
"createdByCustomer": {
"email": "eren.jaeger@neuroflash.com",
"hadTrial": false,
"legacyId": 5,
"name": "Eren Jaeger"
},
"image": {
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"fileName": "string",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"targetAudienceId": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
},
"newPermissions": {
"deletionAllowed": true,
"duplicationAllowed": true,
"updateAllowed": true,
"viewingAllowed": true
},
"permissions": {
"canDelete": false,
"canDuplicate": false,
"canUpdate": false,
"canView": false
}
},
"additionalInformation": "This audience prefers short-form video content",
"country": "US",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"genderDistribution": {
"female": 0.5,
"male": 0.5,
"nonBinary": 0.5,
"preferNotToSay": 0.5
},
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"interests": [
"string"
],
"maxAge": 65,
"minAge": 18,
"name": "Young urban professionals",
"nativeLanguage": "de",
"needs": [
"string"
],
"painPoints": [
"string"
],
"residence": "Berlin",
"summary": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"viewedAt": "2025-01-14T16:20:59Z",
"workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
}
}

Create image creation jobs​

POST/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/image-creation-jobs

Einen Bildgenerierungsjob fĂŒr eine Zielgruppe erstellen. Der dedizierte processImageCreationJobs-Worker nimmt die Zeile auf und fĂŒhrt den LLM-Prompt aus.

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJa
targetAudienceIdstringJa

Antwort​

FeldTypBeschreibung
createdAtstringZeitstempel, wann die Ressource erstellt wurde
createdByUserIdstringnicht gesetzt fĂŒr Arbeitsbereiche, die aus Legacy-Teams importiert wurden
finishedAtstringZeitpunkt, zu dem das Bild gerendert und gespeichert wurde. Null wÀhrend der Verarbeitung.
idstringEindeutige Kennung fĂŒr die Ressource
imageIdstringKennung des Zielgruppenbild-Assets, das von diesem Job produziert wurde. Wird nur gesetzt, nachdem finishedAt gefĂŒllt ist.
targetAudienceIdstringDie Zielgruppe, fĂŒr die dieses Bild generiert wird.
updatedAtstringZeitstempel, wann die Ressource zuletzt aktualisiert wurde
workspaceIdstringDer Arbeitsbereich, zu dem dieser Bildgenerationsjob gehört.

Beispiel​

curl -X POST "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image-creation-jobs" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'

Antwort:

{
"createdAt": "2024-01-15T10:30:00Z",
"createdByUserId": "string",
"finishedAt": "2024-01-15T10:30:00Z",
"id": "string",
"imageId": "string",
"targetAudienceId": "string",
"updatedAt": "2024-01-15T10:30:00Z",
"workspaceId": "string"
}

Zielgruppen auflisten​

GET/v1/workspaces/{workspaceId}/target-audiences

Alle Zielgruppen auflisten, auf die der Benutzer Zugriff hat

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID

Abfrageparameter​

ParameterTypStandardBeschreibung
pageinteger—Seitennummer
sizeinteger—SeitengrĂ¶ĂŸe
searchstring—Zielgruppe nach Name suchen
countrystring—Zielgruppe nach Land filtern
nativeLanguagestring—Zielgruppe nach Muttersprache filtern

Antwort​

FeldTypBeschreibung
dataarray<object>
_embeddedobject
createdByCustomerobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
imageobjectEin Bild, das einer Zielgruppe zugeordnet ist
createdAtstring
createdByUserIdstring
fileNamestringFileName wird zum Generieren eines SpeicherschlĂŒssels verwendet, der bei VervielfĂ€ltigung auch mit dem Dateinamen endet
idstring
targetAudienceIdstring
updatedAtstring
urlstring
newPermissionsobject
deletionAllowedboolean
duplicationAllowedboolean
updateAllowedboolean
viewingAllowedboolean
permissionsobject
canDeleteboolean
canDuplicateboolean
canUpdateboolean
canViewboolean
additionalInformationstring
countrystring
createdAtstring
createdByUserIdstring
genderDistributionobject
femalenumber
malenumber
nonBinarynumber
preferNotToSaynumber
idstring
interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
maxAgeinteger
minAgeintegerWir speichern den Altersbereich als separate Min-/Max-Felder in der Datenbank
namestring
nativeLanguagestring
needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
residencestring
summarystringSummary ist der gerenderte Prosa-Text, der in nachgelagerte Prompts eingegeben wird (Chat, Prompt-LĂ€ufe usw.). Wird ĂŒber die API fĂŒr das Frontend in Chat usw. serialisiert
updatedAtstring
viewedAtstring
workspaceIdstring
pageobject
currentPageinteger
sizeinteger
totalElementsinteger
totalPagesinteger

Beispiel​

curl "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Antwort:

{
"data": [
{
"_embedded": {
"createdByCustomer": {
"email": "...",
"hadTrial": "...",
"legacyId": "...",
"name": "..."
},
"image": {
"createdAt": "...",
"createdByUserId": "...",
"fileName": "...",
"id": "...",
"targetAudienceId": "...",
"updatedAt": "...",
"url": "..."
},
"newPermissions": {
"deletionAllowed": "...",
"duplicationAllowed": "...",
"updateAllowed": "...",
"viewingAllowed": "..."
},
"permissions": {
"canDelete": "...",
"canDuplicate": "...",
"canUpdate": "...",
"canView": "..."
}
},
"additionalInformation": "This audience prefers short-form video content",
"country": "US",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"genderDistribution": {
"female": 0.5,
"male": 0.5,
"nonBinary": 0.5,
"preferNotToSay": 0.5
},
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"interests": [
"string"
],
"maxAge": 65,
"minAge": 18,
"name": "Young urban professionals",
"nativeLanguage": "de",
"needs": [
"string"
],
"painPoints": [
"string"
],
"residence": "Berlin",
"summary": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"viewedAt": "2025-01-14T16:20:59Z",
"workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
}
],
"page": {
"currentPage": 2,
"size": 10,
"totalElements": 35,
"totalPages": 4
}
}

Rufe eine Zielgruppe nach ID ab​

GET/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}

Ruft eine Zielgruppe nach ihrer ID ab

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID
targetAudienceIdstringJaZielgruppen-ID

Antwort​

FeldTypBeschreibung
_embeddedobject
createdByCustomerobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
imageobjectEin Bild, das einer Zielgruppe zugeordnet ist
createdAtstring
createdByUserIdstring
fileNamestringFileName wird zum Generieren eines SpeicherschlĂŒssels verwendet, der bei VervielfĂ€ltigung auch mit dem Dateinamen endet
idstring
targetAudienceIdstring
updatedAtstring
urlstring
newPermissionsobject
deletionAllowedboolean
duplicationAllowedboolean
updateAllowedboolean
viewingAllowedboolean
permissionsobject
canDeleteboolean
canDuplicateboolean
canUpdateboolean
canViewboolean
additionalInformationstring
countrystring
createdAtstring
createdByUserIdstring
genderDistributionobject
femalenumber
malenumber
nonBinarynumber
preferNotToSaynumber
idstring
interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
maxAgeinteger
minAgeintegerWir speichern den Altersbereich als separate Min-/Max-Felder in der Datenbank
namestring
nativeLanguagestring
needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
residencestring
summarystringSummary ist der gerenderte Prosa-Text, der in nachgelagerte Prompts eingegeben wird (Chat, Prompt-LĂ€ufe usw.). Wird ĂŒber die API fĂŒr das Frontend in Chat usw. serialisiert
updatedAtstring
viewedAtstring
workspaceIdstring

Beispiel​

curl "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Antwort:

{
"_embedded": {
"createdByCustomer": {
"email": "eren.jaeger@neuroflash.com",
"hadTrial": false,
"legacyId": 5,
"name": "Eren Jaeger"
},
"image": {
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"fileName": "string",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"targetAudienceId": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
},
"newPermissions": {
"deletionAllowed": true,
"duplicationAllowed": true,
"updateAllowed": true,
"viewingAllowed": true
},
"permissions": {
"canDelete": false,
"canDuplicate": false,
"canUpdate": false,
"canView": false
}
},
"additionalInformation": "This audience prefers short-form video content",
"country": "US",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"genderDistribution": {
"female": 0.5,
"male": 0.5,
"nonBinary": 0.5,
"preferNotToSay": 0.5
},
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"interests": [
"string"
],
"maxAge": 65,
"minAge": 18,
"name": "Young urban professionals",
"nativeLanguage": "de",
"needs": [
"string"
],
"painPoints": [
"string"
],
"residence": "Berlin",
"summary": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"viewedAt": "2025-01-14T16:20:59Z",
"workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
}

Rufe ein Zielgruppenbild ab​

GET/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/image

Gibt eine signierte URL fĂŒr das Zielgruppenbild zurĂŒck

Pfadparameter​

ParameterTypErforderlichBeschreibung
targetAudienceIdstringJaZielgruppen-ID

Antwort​

FeldTypBeschreibung
createdAtstring
createdByUserIdstring
fileNamestringFileName wird zum Generieren eines SpeicherschlĂŒssels verwendet, der bei VervielfĂ€ltigung auch mit dem Dateinamen endet
idstring
targetAudienceIdstring
updatedAtstring
urlstring

Beispiel​

curl "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Antwort:

{
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"fileName": "string",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"targetAudienceId": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
}

Get image creation jobs​

GET/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/image-creation-jobs

Bildgenerierungsjobs fĂŒr eine Zielgruppe auflisten, neueste zuerst.

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJa
targetAudienceIdstringJa

Abfrageparameter​

ParameterTypStandardBeschreibung
pageinteger1Seitennummer fĂŒr Paginierung, beginnend mit 1 fĂŒr die erste Seite
sizeinteger20Anzahl der Elemente, die pro Seite zurĂŒckgegeben werden
sortstring—Feld, nach dem sortiert werden soll
orderstringascSortierreihenfolge

Antwort​

FeldTypBeschreibung
dataarray<object>
createdAtstringZeitstempel, wann die Ressource erstellt wurde
createdByUserIdstringnicht gesetzt fĂŒr Arbeitsbereiche, die aus Legacy-Teams importiert wurden
finishedAtstringZeitpunkt, zu dem das Bild gerendert und gespeichert wurde. Null wÀhrend der Verarbeitung.
idstringEindeutige Kennung fĂŒr die Ressource
imageIdstringKennung des Zielgruppenbild-Assets, das von diesem Job produziert wurde. Wird nur gesetzt, nachdem finishedAt gefĂŒllt ist.
targetAudienceIdstringDie Zielgruppe, fĂŒr die dieses Bild generiert wird.
updatedAtstringZeitstempel, wann die Ressource zuletzt aktualisiert wurde
workspaceIdstringDer Arbeitsbereich, zu dem dieser Bildgenerationsjob gehört.
pageobject
currentPageinteger
sizeinteger
totalElementsinteger
totalPagesinteger

Beispiel​

curl "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image-creation-jobs" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Antwort:

{
"data": [
{
"createdAt": "2024-01-15T10:30:00Z",
"createdByUserId": "string",
"finishedAt": "2024-01-15T10:30:00Z",
"id": "string",
"imageId": "string",
"targetAudienceId": "string",
"updatedAt": "2024-01-15T10:30:00Z",
"workspaceId": "string"
}
],
"page": {
"currentPage": 0,
"size": 0,
"totalElements": 0,
"totalPages": 0
}
}

Get​

GET/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/image-creation-jobs/{jobId}

Eine einzelne Bildgenerierungsaufgabe lesen; imageUrl wird ausgefĂŒllt, sobald status=finished.

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJa
targetAudienceIdstringJa
jobIdstringJa

Antwort​

FeldTypBeschreibung
createdAtstringZeitstempel, wann die Ressource erstellt wurde
createdByUserIdstringnicht gesetzt fĂŒr Arbeitsbereiche, die aus Legacy-Teams importiert wurden
finishedAtstringZeitpunkt, zu dem das Bild gerendert und gespeichert wurde. Null wÀhrend der Verarbeitung.
idstringEindeutige Kennung fĂŒr die Ressource
imageIdstringKennung des Zielgruppenbild-Assets, das von diesem Job produziert wurde. Wird nur gesetzt, nachdem finishedAt gefĂŒllt ist.
targetAudienceIdstringDie Zielgruppe, fĂŒr die dieses Bild generiert wird.
updatedAtstringZeitstempel, wann die Ressource zuletzt aktualisiert wurde
workspaceIdstringDer Arbeitsbereich, zu dem dieser Bildgenerationsjob gehört.

Beispiel​

curl "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image-creation-jobs/{job_id}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Antwort:

{
"createdAt": "2024-01-15T10:30:00Z",
"createdByUserId": "string",
"finishedAt": "2024-01-15T10:30:00Z",
"id": "string",
"imageId": "string",
"targetAudienceId": "string",
"updatedAt": "2024-01-15T10:30:00Z",
"workspaceId": "string"
}

Aktualisiere eine Zielgruppe​

PUT/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}

Aktualisiert eine vorhandene Zielgruppe

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID
targetAudienceIdstringJaZielgruppen-ID

Anfrage-Body​

FeldTypErforderlichBeschreibung
additionalInformationstringNein
countrystringNein
genderDistributionobjectJa
femalenumberJa
malenumberJa
nonBinarynumberJa
preferNotToSaynumberJa
interestsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
maxAgeintegerJa
minAgeintegerJaWir speichern den Altersbereich als separate Min-/Max-Felder in der Datenbank
namestringJa
nativeLanguagestringNein
needsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
painPointsarray<string>JaEine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
residencestringJa

Antwort​

FeldTypBeschreibung
_embeddedobject
createdByCustomerobject
emailstringE-Mail des Kunden
hadTrialbooleanWahr, wenn der Kunde jemals eine Testversion in einem beliebigen Arbeitsbereich gestartet hat
legacyIdintegerKundenn-ID im Altsystem
namestringName des Kunden
imageobjectEin Bild, das einer Zielgruppe zugeordnet ist
createdAtstring
createdByUserIdstring
fileNamestringFileName wird zum Generieren eines SpeicherschlĂŒssels verwendet, der bei VervielfĂ€ltigung auch mit dem Dateinamen endet
idstring
targetAudienceIdstring
updatedAtstring
urlstring
newPermissionsobject
deletionAllowedboolean
duplicationAllowedboolean
updateAllowedboolean
viewingAllowedboolean
permissionsobject
canDeleteboolean
canDuplicateboolean
canUpdateboolean
canViewboolean
additionalInformationstring
countrystring
createdAtstring
createdByUserIdstring
genderDistributionobject
femalenumber
malenumber
nonBinarynumber
preferNotToSaynumber
idstring
interestsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
maxAgeinteger
minAgeintegerWir speichern den Altersbereich als separate Min-/Max-Felder in der Datenbank
namestring
nativeLanguagestring
needsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
painPointsarray<string>Eine Liste von Zeichenketten, die in der Datenbank als JSON gespeichert sind
residencestring
summarystringSummary ist der gerenderte Prosa-Text, der in nachgelagerte Prompts eingegeben wird (Chat, Prompt-LĂ€ufe usw.). Wird ĂŒber die API fĂŒr das Frontend in Chat usw. serialisiert
updatedAtstring
viewedAtstring
workspaceIdstring

Beispiel​

curl -X PUT "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"additionalInformation": "string",
"country": "string",
"genderDistribution": {},
"interests": [],
"maxAge": 0,
"minAge": 0,
"name": "string",
"nativeLanguage": "string",
"needs": [],
"painPoints": [],
"residence": "string"
}'

Antwort:

{
"_embedded": {
"createdByCustomer": {
"email": "eren.jaeger@neuroflash.com",
"hadTrial": false,
"legacyId": 5,
"name": "Eren Jaeger"
},
"image": {
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"fileName": "string",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"targetAudienceId": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
},
"newPermissions": {
"deletionAllowed": true,
"duplicationAllowed": true,
"updateAllowed": true,
"viewingAllowed": true
},
"permissions": {
"canDelete": false,
"canDuplicate": false,
"canUpdate": false,
"canView": false
}
},
"additionalInformation": "This audience prefers short-form video content",
"country": "US",
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"genderDistribution": {
"female": 0.5,
"male": 0.5,
"nonBinary": 0.5,
"preferNotToSay": 0.5
},
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"interests": [
"string"
],
"maxAge": 65,
"minAge": 18,
"name": "Young urban professionals",
"nativeLanguage": "de",
"needs": [
"string"
],
"painPoints": [
"string"
],
"residence": "Berlin",
"summary": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"viewedAt": "2025-01-14T16:20:59Z",
"workspaceId": "113c0b32-ed6c-4421-b7da-d1faf238eb56"
}

Aktualisiere das Symbol einer Zielgruppe​

PUT/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/image

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID
targetAudienceIdstringJaZielgruppen-ID

Anfrage-Body​

FeldTypErforderlichBeschreibung
base64stringJa
contentTypestringJa
fileNamestringJa

Antwort​

FeldTypBeschreibung
createdAtstring
createdByUserIdstring
fileNamestringFileName wird zum Generieren eines SpeicherschlĂŒssels verwendet, der bei VervielfĂ€ltigung auch mit dem Dateinamen endet
idstring
targetAudienceIdstring
updatedAtstring
urlstring

Beispiel​

curl -X PUT "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"base64": "string",
"contentType": "string",
"fileName": "string"
}'

Antwort:

{
"createdAt": "2025-01-14T16:20:59Z",
"createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
"fileName": "string",
"id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
"targetAudienceId": "string",
"updatedAt": "2025-01-14T16:20:59Z",
"url": "https://storage.googleapis.com/audience-images/113c0b32-ed6c-4421-b7da-d1faf238eb56.jpg"
}

Lösche eine Zielgruppe​

DELETE/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}

Löscht eine vorhandene Zielgruppe

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaArbeitsbereich-ID
targetAudienceIdstringJaZielgruppen-ID

Beispiel​

curl -X DELETE "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Lösche ein Zielgruppenbild​

DELETE/v1/workspaces/{workspaceId}/target-audiences/{targetAudienceId}/image

Löscht ein vorhandenes Bild fĂŒr eine Zielgruppe

Pfadparameter​

ParameterTypErforderlichBeschreibung
targetAudienceIdstringJaZielgruppen-ID

Beispiel​

curl -X DELETE "https://app.neuroflash.com/api/audience-service/v1/workspaces/{workspace_id}/target-audiences/{target_audience_id}/image" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"