Bilder

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

Bild in den Arbeitsbereich hochladen

POST/v1/workspaces/{workspaceId}/images

Erstellt ein Bild im Arbeitsbereich aus der bereitgestellten URL oder dem Daten-URI. Die zurückgegebene id kann als Eingabe für image-edit-tasks oder image-upscale-tasks übergeben werden.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja

Anfrage-Body

imageUrlstringJaHTTP(S)-URL des abzurufenden Bildes oder ein Inline-data:-URI

fileNamestringJaDateiname zum Herunterladen einschließlich Erweiterung. Serverseitig bereinigt (Pfadkomponenten entfernt, alphanumerische Zeichen zu Bindestrichen zusammengefasst). Begrenzt auf 50 Zeichen.

Antwort

idstringeindeutige UUID

generationIdstringGroups every image produced by one generation request. Multiple rows can share the same generationId when a request asked for more than one image.

workspaceIdstringowning workspace ID

createdByUserIdstringuserId of the account that created this image

promptstringprompt that produced the image (empty for upscales or uploads)

modelstringModell zur Bildproduktion

parametersobjectGenerierungsparameter (Seitenverhältnis, Format usw.)

inputImageIdsobjectIDs von Eingabebildern für Bearbeitungs- oder Hochskalierungsaufgaben

fileNamestringBenutzerfreundlicher Dateiname (mit Erweiterung) geeignet für Downloads. Uploads tragen den vom Benutzer angegebenen Namen; Generierungen erhalten einen LLM-abgeleiteten Slug; Bearbeitungen/Hochskalierungen ergänzen den Namen der Eingabe. Maximal 50 Zeichen.

imageWidthobjectBildbreite in Pixeln

imageHeightobjectBildhöhe in Pixeln

imageSizeobjectBilddateigröße in Bytes

createdAtstringErstellungszeitstempel als ISO 8601

updatedAtstringZeitstempel der letzten Aktualisierung als ISO 8601

shareKeystringHMAC-Schlüssel zur Autorisierung des öffentlichen Freigabelinks dieses Bildes (als ?key= übergeben)

_linksobject

contentstringTemporäre URL zur Bilddatei

downloadstringTemporäre URL, die einen Dateidownload erzwingt (content-disposition: attachment)

Beispiel

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/image-service/v1/workspaces/{workspace_id}/images" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "imageUrl": "string",
      "fileName": "string"
  }'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/image-service/v1/workspaces/{workspace_id}/images",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "imageUrl": "string",
        "fileName": "string"
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/image-service/v1/workspaces/${workspaceId}/images`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "imageUrl": "string",
          "fileName": "string"
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"imageUrl": "string",
		"fileName": "string",
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/image-service/v1/workspaces/"+workspaceID+"/images", 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:

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "generationId": "string",
  "workspaceId": "string",
  "createdByUserId": "string",
  "prompt": "string",
  "model": "string",
  "parameters": {},
  "inputImageIds": {},
  "fileName": "string",
  "imageWidth": {},
  "imageHeight": {},
  "imageSize": {},
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "shareKey": "string",
  "_links": {
    "content": "string",
    "download": "string"
  }
}

Bilder in einem Arbeitsbereich auflisten (paginiert)

GET/v1/workspaces/{workspaceId}/images

Gibt Bilder zurück, die vom authentifizierten Benutzer erstellt wurden, neueste zuerst.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja

Abfrageparameter

Parameter	Typ	Standard	Beschreibung
`page`	integer	`1`	1-basierte Seitennummer
`size`	integer	`50`	Elemente pro Seite (max. 200)
`generationId`	string	—	Filter für Bilder, die durch eine bestimmte Generierungsanfrage erstellt wurden (nützlich zum Abrufen aller N-Ausgaben eines POST/PUT-Aufrufs)
`modelId`	string	—	Filter für Bilder, die durch diese Modell-ID erstellt wurden

Antwort

pageobject

sizeintegerAnzahl der pro Seite angeforderten Elemente

totalElementsintegerGesamtzahl der übereinstimmenden Elemente

totalPagesintegerGesamtzahl der Seiten

currentPageinteger1-basierter Index der zurückgegebenen Seite

dataarray<object>

idstringeindeutige UUID

generationIdstringGroups every image produced by one generation request. Multiple rows can share the same generationId when a request asked for more than one image.

workspaceIdstringowning workspace ID

createdByUserIdstringuserId of the account that created this image

promptstringprompt that produced the image (empty for upscales or uploads)

modelstringModell zur Bildproduktion

parametersobjectGenerierungsparameter (Seitenverhältnis, Format usw.)

inputImageIdsobjectIDs von Eingabebildern für Bearbeitungs- oder Hochskalierungsaufgaben

imageWidthobjectBildbreite in Pixeln

imageHeightobjectBildhöhe in Pixeln

imageSizeobjectBilddateigröße in Bytes

createdAtstringErstellungszeitstempel als ISO 8601

updatedAtstringZeitstempel der letzten Aktualisierung als ISO 8601

shareKeystringHMAC-Schlüssel zur Autorisierung des öffentlichen Freigabelinks dieses Bildes (als ?key= übergeben)

_linksobject

contentstringTemporäre URL zur Bilddatei

downloadstringTemporäre URL, die einen Dateidownload erzwingt (content-disposition: attachment)

Beispiel

cURL
Python
Node.js
Go

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

import requests

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

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

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

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

Antwort:

{
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "currentPage": 0
  },
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "generationId": "string",
      "workspaceId": "string",
      "createdByUserId": "string",
      "prompt": "string",
      "model": "string",
      "parameters": {},
      "inputImageIds": {},
      "fileName": "string",
      "imageWidth": {},
      "imageHeight": {},
      "imageSize": {},
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "shareKey": "string",
      "_links": {
        "content": "string",
        "download": "string"
      }
    }
  ]
}

Metadaten eines einzelnen Bildes abrufen

GET/v1/workspaces/{workspaceId}/images/{imageId}

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja
`imageId`	string	Ja

Antwort

idstringeindeutige UUID

generationIdstringGroups every image produced by one generation request. Multiple rows can share the same generationId when a request asked for more than one image.

workspaceIdstringowning workspace ID

createdByUserIdstringuserId of the account that created this image

promptstringprompt that produced the image (empty for upscales or uploads)

modelstringModell zur Bildproduktion

parametersobjectGenerierungsparameter (Seitenverhältnis, Format usw.)

inputImageIdsobjectIDs von Eingabebildern für Bearbeitungs- oder Hochskalierungsaufgaben

imageWidthobjectBildbreite in Pixeln

imageHeightobjectBildhöhe in Pixeln

imageSizeobjectBilddateigröße in Bytes

createdAtstringErstellungszeitstempel als ISO 8601

updatedAtstringZeitstempel der letzten Aktualisierung als ISO 8601

shareKeystringHMAC-Schlüssel zur Autorisierung des öffentlichen Freigabelinks dieses Bildes (als ?key= übergeben)

_linksobject

contentstringTemporäre URL zur Bilddatei

downloadstringTemporäre URL, die einen Dateidownload erzwingt (content-disposition: attachment)

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/image-service/v1/workspaces/{workspace_id}/images/{image_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

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

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

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

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

Antwort:

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "generationId": "string",
  "workspaceId": "string",
  "createdByUserId": "string",
  "prompt": "string",
  "model": "string",
  "parameters": {},
  "inputImageIds": {},
  "fileName": "string",
  "imageWidth": {},
  "imageHeight": {},
  "imageSize": {},
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "shareKey": "string",
  "_links": {
    "content": "string",
    "download": "string"
  }
}

Bild löschen

DELETE/v1/workspaces/{workspaceId}/images/{imageId}

Nur der Eigentümer des Bildes (createdByUserId) oder ein Benutzer mit der Rolle NF_ADMIN, NF_CUSTOMER_SUPPORT oder ADMIN_SERVICE kann ein Bild löschen.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja
`imageId`	string	Ja

Beispiel

cURL
Python
Node.js
Go

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

import requests

requests.delete(
    f"https://app.neuroflash.com/api/image-service/v1/workspaces/{workspace_id}/images/{image_id}",
    headers={"Authorization": f"Bearer {token}"},
)

await fetch(
  `https://app.neuroflash.com/api/image-service/v1/workspaces/${workspaceId}/images/${imageId}`,
  {
    method: "DELETE",
    headers: { Authorization: `Bearer ${token}` },
  }
);

req, _ := http.NewRequest("DELETE", "https://app.neuroflash.com/api/image-service/v1/workspaces/"+workspaceID+"/images/"+imageID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

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

Bild in den Arbeitsbereich hochladen​

Pfadparameter​

Anfrage-Body​

Antwort​

Beispiel​

Bilder in einem Arbeitsbereich auflisten (paginiert)​

Pfadparameter​

Abfrageparameter​

Antwort​

Beispiel​

Metadaten eines einzelnen Bildes abrufen​

Pfadparameter​

Antwort​

Beispiel​

Bild löschen​

Pfadparameter​

Beispiel​

Bild in den Arbeitsbereich hochladen

Pfadparameter

Anfrage-Body

Antwort

Beispiel

Bilder in einem Arbeitsbereich auflisten (paginiert)

Pfadparameter

Abfrageparameter

Antwort

Beispiel

Metadaten eines einzelnen Bildes abrufen

Pfadparameter

Antwort

Beispiel

Bild löschen

Pfadparameter

Beispiel