Dokumente

Notizen
Expertenlevel
Der API-Schlüssel sollte als Bearer-Token im Autorisierungsheader der Anfrage gesendet werden. Erhalten Sie Ihren API-Schlüssel.
Liste

API-Endpunkt:

GET 
https://ai.roccomedia.de/api/v1/documents

Beispielanfrage: 

curl --location --request GET 'https://ai.roccomedia.de/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Die Suchanfrage.
search_by
optional string
Suche nach. Mögliche Werte sind: name für Name, result für Ergebnis. Standardwert: name.
template_id
optional integer
Nach Vorlagen-ID filtern. Mögliche Werte sind: 1 für Freestyle, 2 für Über uns, 3 für Werbung, 4 für Artikel, 5 für Blog-Einführung, 6 für Blog-Übersicht, 7 für Blog-Abschluss, 8 für Blog-Absatz, 9 für Blog-Beitrag, 10 für Blog-Abschnitt, 11 für Diskussionspunkte für den Blog, 12 für Blog-Titel, 13 für Handlungsaufforderung, 14 für Inhaltsüberarbeitung, 15 für Inhaltszusammenfassung, 16 für FAQ, 17 für Hashtags, 18 für Überschrift, 19 für Wie es funktioniert, 20 für Meta-Beschreibung, 21 für Meta-Keywords, 22 für Missionserklärung, 23 für Newsletter, 24 für Schmerz-Aufwühlen-Lösung, 25 für Absatz, 26 für Pressemitteilung, 27 für Social-Media-Beitrag, 28 für Social-Media-Beitragsbeschriftung, 29 für Start-up-Ideen, 30 für Start-up-Namen, 31 für Unterüberschrift, 32 für Empfehlung, 33 für Tweet, 34 für Twitter-Thread, 35 für Wertversprechen, 36 für Video-Beschreibung, 37 für Videoskript, 38 für Video-Tags, 39 für Video-Titel, 40 für Visionserklärung, 43 für Produktblatt, 44 für Willkommens-E-Mail, 45 für Push-Benachrichtigung, 46 für Blog-Listicle, 47 für Inhaltsgrammatik, 48 für Blog-Tags, 49 für Pro und Kontra, 50 für Google-Anzeige, 51 für Facebook-Anzeige, 52 für Stellenbeschreibung, 53 für Bewertung, 54 für Funktionsabschnitt. Standardwert: freestyle.
favorite
optional boolean
Nach Favoriten filtern.
sort_by
optional string
Sortieren nach. Mögliche Werte sind: id für Erstellungsdatum, name für Name. Standardwert: id.
sort
optional string
Sortieren. Mögliche Werte sind: desc für Absteigend, asc für Aufsteigend. Standardwert: desc.
per_page
optional integer
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Standardwert: 10.
Anzeigen

API-Endpunkt:

GET 
https://ai.roccomedia.de/api/v1/documents/{id}

Beispielanfrage: 

curl --location --request GET 'https://ai.roccomedia.de/api/v1/documents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Speichern

API-Endpunkt:

POST 
https://ai.roccomedia.de/api/v1/documents

Beispielanfrage: 

curl --location --request POST 'https://ai.roccomedia.de/api/v1/documents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'prompt={prompt}'
Parameter
Typ
Beschreibung
name
erforderlich string
The document name.
prompt
erforderlich string
Die Anweisungen für die KI.
creativity
erforderlich float
The creative level of the result. Mögliche Werte sind: 0 für Wiederholend, 0.25 für Deterministisch, 0.5 für Original, 0.75 für Kreativ, 1 für Imaginativ. Standardwert: 0.5.
Aktualisieren

API-Endpunkt:

PUT PATCH 
https://ai.roccomedia.de/api/v1/documents/{id}

Beispielanfrage: 

curl --location --request PUT 'https://ai.roccomedia.de/api/v1/documents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
name
optional string
The document name.
result
optional string
Das Dokumentergebnis.
favorite
optional boolean
Ob das Dokument als Favorit markiert ist oder nicht.
Löschen

API-Endpunkt:

DELETE 
https://ai.roccomedia.de/api/v1/documents/{id}

Beispielanfrage: 

curl --location --request DELETE 'https://ai.roccomedia.de/api/v1/documents/{id}' \
--header 'Authorization: Bearer {api_key}'