Documentazione API USER

Introduzione

Questa API consente di ottenere informazioni dettagliate sull'utente MrktgAI autenticato tramite un token di autorizzazione Bearer. Le informazioni restituite includono dettagli sull'utente, sul profilo, sui pagamenti e sulle risorse associate all'account.

Requisiti

Per utilizzare questa API, è necessario avere un token di autorizzazione Bearer valido, che deve essere fornito nell'header della richiesta HTTP.

Endpoint

GET https://multimrktg.com/api/user

Parametri

Nessun parametro è richiesto per questa API.

Headers

Nome header Descrizione Esempio
Authorization Bearer token per l'autenticazione dell'utente Bearer eyJhbGciOiJIUzI1Ni...

Risposta

Se la richiesta ha successo, l'API restituirà un oggetto JSON con le seguenti proprietà:

Nome proprietà Descrizione Esempio
MrktgAI Messaggio di successo Richiesta autorizzata con successo
id_utente ID dell'utente 12345
id_profilo ID del profilo dell'utente 67890
username Nome utente john_doe
email Indirizzo email dell'utente joe@example.com
data_iscrizione Data di iscrizione dell'utente 2021-01-01
account Tipo di account (es. primary) primary
token mensili Numero di token mensili disponibili 100
crediti rimanenti Numero di crediti rimanenti 50
immagini mensili Numero di immagini mensili disponibili 30
crediti immagini Numero di crediti immagini 10
ultimo pagamento ID dell'ultimo pagamento effettuato 11111
data pagamento Data dell'ultimo pagamento effettuato 2021-01-01
data scadenza Data di scadenza dell'ultimo pagamento effettuato 2021-02-01

Esempio di risposta

{
    "MrktgAI": "Richiesta autorizzata con successo",
    "id_utente": 12345,
    "id_profilo": 67890,
    "username": "john_doe",
    "email": "john.doe@example.com",
    "data_iscrizione": "2021-01-01",
    "account": "premium",
    "token mensili": 100,
    "crediti rimanenti": 50,
    "immagini mensili": 30,
    "crediti immagini": 10,
    "ultimo pagamento": 11111,
    "data pagamento": "2021-01-01",
    "data scadenza": "2021-02-01"
}

Codici di errore

Questa API restituirà uno dei seguenti codici di errore HTTP in caso di fallimento:

Codice HTTP Messaggio di errore Descrizione
401 Token mancante o non valido Il token Bearer non è stato fornito o è malformato
401 Token invalido Il token fornito non è valido
401 Errore nell'esecuzione... Errore nel recuperare le informazioni dall'utente dal database

Esempio di chiamata API in Python

import requests

url = "https://multimrktg.com/api/user"
headers = {
    "Authorization": "Bearer eyJhbGciOiJIUzI1Ni..."
}

response = requests.get(url, headers=headers)
data = response.json()

print(data)

Conclusione

Questa API fornisce un modo semplice ed efficace per ottenere informazioni dettagliate sull'utente e sulle sue risorse associate. Per utilizzare l'API, è necessario un token Bearer valido, che deve essere fornito nell'header della richiesta HTTP.




Documentazione API TEXT

Generatore di Testo con Limite di Token

Introduzione

Questa API permette di generare testi in italiano utilizzando il modello di linguaggio COPY di MrktgAI con un limite di token massimo. L'API accetta una richiesta POST contenente un prompt in italiano e il numero massimo di token da generare, e restituisce un testo generato in base al prompt fornito e al limite di token impostato.

Requisiti

Per utilizzare questa API, è necessario:

Endpoint

URL: https://multimrktg.com/api/text
Metodo: POST

Autenticazione

L'autenticazione viene effettuata tramite un Bearer Token. Il token deve essere incluso nell'header della richiesta come segue:

Authorization: Bearer your_bearer_token

Parametri della richiesta

La richiesta deve contenere un oggetto JSON con i seguenti parametri:

Esempio di richiesta JSON:
{
    "prompt": "Descrivi il funzionamento di una bicicletta",
    "max_token": 100
}

Risposta dell'API

L'API restituisce un oggetto JSON contenente il testo generato in base al prompt fornito e al limite di token impostato, oltre al numero di token utilizzati. Esempio di risposta JSON:

{
    "MrktgAI": "Richiesta autorizzata con successo",
    "Testo_Generato": "Una bicicletta è un veicolo a due ruote che viene azionato mediante la forza muscolare del ciclista...",
    "Token_Utilizzati": 98
}

Gestione degli errori

L'API restituisce codici di errore HTTP appropriati per indicare il tipo di errore. Alcuni esempi di errori comuni sono:

Esempio di chiamata API con cURL

curl -X POST \
https://multimrktg.com/api/text \
-H 'Authorization: Bearer your_bearer_token' \
-H 'Content-Type: application/json' \
-d '{"prompt": "Descrivi il funzionamento di una bicicletta", "max_token": 100}'

Utilizzo dell'API nel codice PHP

<?php
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://multimrktg.com/api/text");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["prompt" => "Descrivi il funzionamento di una bicicletta", "max_token" => 100]));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: Bearer your_bearer_token"
]);

$response = curl_exec($ch);

curl_close($ch);

$response = json_decode($response, true);

echo "Testo generato: " . $response["Testo_Generato"] . "\n";
echo "Token utilizzati: " . $response["Token_Utilizzati"];
?>

Note




Documentazione API CHAT

Generatore di Testo (Chat)

Introduzione

Questa API permette di generare testi in italiano utilizzando il modello di linguaggio CHAT di MrktgAI. L'API accetta una richiesta POST contenente un prompt e un contesto in italiano e restituisce un testo generato in base al prompt fornito.

Requisiti

Per utilizzare questa API, è necessario:

Endpoint

URL: https://multimrktg.com/api/chat
Metodo: POST

Autenticazione

L'autenticazione viene effettuata tramite un Bearer Token. Il token deve essere incluso nell'header della richiesta come segue:

Authorization: Bearer your_bearer_token
    

Parametri della richiesta

La richiesta deve contenere un oggetto JSON con il seguente parametro:

Esempio di richiesta JSON:

{
"prompt": "Descrivi il funzionamento di una bicicletta",
"info": "Sei un assistente chatbot esperto in veicoli e tutto quello che li riguarda"
}
    

Risposta dell'API

L'API restituisce un oggetto JSON contenente il testo generato in base al prompt fornito.

Esempio di risposta JSON:

{
"text": "Una bicicletta è un veicolo a due ruote che viene azionato mediante la forza muscolare del ciclista..."
}
    

Gestione degli errori

L'API restituisce codici di errore HTTP appropriati per indicare il tipo di errore. Alcuni esempi di errori comuni sono:

Esempio di chiamata API con cURL

curl -X POST \
https://multimrktg.com/api/chat \
-H 'Authorization: Bearer your_bearer_token' \
-H 'Content-Type: application/json' \
-d '{"prompt": "Descrivi il funzionamento di una bicicletta"}'
    

Utilizzo dell'API nel codice PHP

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://multimrktg.com/api/chat");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["prompt" => "Descrivi il funzionamento di una bicicletta"]));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Content-Type: application/json",
"Authorization: Bearer your_bearer_token"
]);

$response = curl_exec($ch);

curl_close($ch);

$response = json_decode($response, true);

echo "Testo generato: " . $response["text"];
    

Note

- Il testo generato può variare in termini di lunghezza e qualità a seconda del prompt fornito e delle impostazioni del modello.
- L'API non garantisce una risposta immediata e può richiedere tempo per generare il testo, a seconda della complessità del prompt e delle risorse disponibili.




Documentazione API IMAGE

Generatore di Immagini

Introduzione

Questa API permette di generare immagini a partire da un testo fornito come input. L'API utilizza un modello MrktgAI di intelligenza artificiale per creare le immagini.

Autenticazione

Per utilizzare l'API, è necessario fornire un token di autenticazione valido nel formato Bearer {token} nell'header Authorization della richiesta. Il token viene verificato confrontandolo con i token presenti nel database degli utenti.

Se il token non è presente o non è valido, l'API restituirà un errore con codice 401 (Unauthorized).

Endpoint

L'endpoint per effettuare la chiamata all'API è:

POST https://multimrktg.com/api/image

Parametri della richiesta

La richiesta deve essere inviata con il seguente parametro nel corpo della richiesta:

Esempio di richiesta

{
   "prompt": "Un paesaggio montano con un tramonto"
}

Risposta

La risposta dell'API contiene le seguenti informazioni:

Esempio di risposta

{
   "MrktgAI": "Richiesta autorizzata con successo",
   "Img_Generata": "data:image/png;base64,iVBORw0KGg...",
   "Img_Link": "https://www.multimrktg.com/assets/image/123-uniqueid.png"
}

Gestione degli errori

L'API restituisce i seguenti codici di errore:

Limitazioni e crediti

Ogni utente ha un limite di crediti o token che può utilizzare per generare immagini. Se un utente ha esaurito i suoi crediti, l'API restituirà un errore con codice 402 (Payment Required).

Utilizzo dell'API in PHP

<?php
// Impostare il token di autenticazione
$token = "your-bearer-token";

// Impostare il prompt
$prompt = "Un paesaggio montano con un tramonto";

// Preparare la richiesta
$apiUrl = "https://multimrktg.com/api/image";
$headers = [
    "Content-Type: application/json",
    "Authorization: Bearer " . $token
];
$requestBody = [
    "prompt" => $prompt
];

// Inviare la richiesta
$ch = curl_init($apiUrl);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($requestBody));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

// Gestire la risposta
if ($httpCode == 200) {
    $data = json_decode($response, true);
    $imageBase64 = $data["Img_Generata"];
    $imageLink = $data["Img_Link"];

    echo "Immagine generata con successo:\n";
    echo "Base64: " . $imageBase64 . "\n";
    echo "Link: " . $imageLink . "\n";
} else {
    echo "Errore: " . $httpCode . "\n";
    echo "Dettagli: " . $response . "\n";
}

curl_close($ch);
?>

Note

- L'immagine generata può variare in termini qualità a seconda del prompt fornito e delle impostazioni del modello.
- L'API non garantisce una risposta immediata e può richiedere tempo per generare l'immagine, a seconda della complessità del prompt e delle risorse disponibili.




Documentazione API VOICE

Generatore di Voci AUDIO

Introduzione

Questa API ti permette di generare contenuti audio utilizzando il servizio Text-to-Speech di MrktgAI. L'API richiede un token di autorizzazione e accetta vari parametri per personalizzare l'output audio. Inoltre, l'API tiene traccia dei token utilizzati e fornisce un link per scaricare l'audio generato.

Autenticazione

Per utilizzare l'API, è necessario fornire un token di autenticazione valido nel formato Bearer {token} nell'header Authorization della richiesta. Il token viene verificato confrontandolo con i token presenti nel database degli utenti.

Se il token non è presente o non è valido, l'API restituirà un errore con codice 401 (Unauthorized).

Endpoint

POST https://multimrktg.com/api/voice

Parametri di richiesta

Voci disponibili

Risposta

La risposta sarà in formato JSON e includerà i seguenti campi:

Esempio di chiamata API

Richiesta

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"prompt": "Ciao, come stai?", "voice": "NEURALE (Maschio)"}' \
https://multimrktg.com/api/voice

Risposta

{
"MrktgAI": "Richiesta autorizzata con successo",
"Audio_Generato": "UklGRuYcAABXQVZFZm10IB... (base64 audio data)",
"Audio_Link": "https://www.multimrktg.com/assets/audio/12345-abcdef.mp3",
"Token_Utilizzati": 17
}

Note




Documentazione API SPEACH

Converti da Audio a Testo.

Introduzione

Questa API consente agli utenti di convertire un file audio in testo utilizzando il modello SPEACH di MrktgAI. L'utente carica un file audio codificato in Base64 e l'API restituisce il testo estratto insieme al numero di token utilizzati e caratteri estratti. L'API verifica anche la validità del token Bearer e i crediti disponibili dell'utente prima di elaborare la richiesta.

Endpoint API

POST https://multimrktg.com/api/speach

Intestazioni richiesta

Intestazione Descrizione
Authorization Token Bearer per l'utente (Formato: "Bearer {token}")
Content-Type Deve essere impostato su "application/json" per il corpo della richiesta

Corpo della richiesta

Parametro Tipo Descrizione
file string Il file audio codificato in Base64 da convertire in testo

Esempio:

{
"file": "//NExAAAAANIAAAAAExBTUUzLjEwMFVVVVVVV..."
}

Risposta

Parametro Tipo Descrizione
MrktgAI string Conferma dell'autorizzazione riuscita
Testo Estratto string Il testo estratto dal file audio
Token_Utilizzati integer Il numero di token utilizzati per la conversione
N_Caratteri integer Il numero di caratteri estratti dal file audio

Esempio:

{
"MrktgAI": "Richiesta autorizzata con successo",
"Testo Estratto": "Ciao, questo è un testo di esempio.",
"Token_Utilizzati": 6,
"N_Caratteri": 24
}

Risposte di errore

Codice stato HTTP Messaggio di errore Descrizione
401 Token mancante o non valido Token Bearer mancante o non valido
401 Token invalido Token Bearer vuoto
401 Token non valido Il token Bearer non corrisponde all'utente
402 Crediti o Token esauriti Crediti o token non disponibili per l'utente

Utilizzo

  1. Assicurarsi che l'utente abbia un token Bearer valido e crediti o token sufficienti.
  2. Inviare una richiesta POST all'endpoint `https://multimrktg.com/api/speach` con le intestazioni e il corpo della richiesta richiesti.
  3. L'API restituirà il testo estratto, il numero di token utilizzati e il numero di caratteri estratti.
  4. La risposta includerà anche il token Bearer nell'intestazione 'Authorization'.

Note




Documentazione API MRKTG

Genera Testo, Immagine e Voce Audio in una sola chiamata.

Introduzione

Questa API consente di generare testo, immagini e audio basati su un prompt di input fornito dall'utente. L'API utilizza i modelli MrktgAI per generare il testo, immagini e l'audio.

Requisiti

Endpoint

POST https://www.multimrktg.com/api/mrktg

Headers

Content-Type: application/json
Authorization: Bearer {il_tuo_token}

Body

Il body della richiesta deve contenere i seguenti campi:

Esempio di body:

{
"prompt": "Descrivere il Colosseo",
"image": "Il Colosseo al tramonto",
"voice": "NEURALE (Femmina)"
}

Risposta

La risposta dell'API contiene i seguenti campi:

Esempio di risposta:

{
"MrktgAI": "Richiesta autorizzata con successo",
"Testo_Generato": "Il Colosseo è un antico anfiteatro romano situato nel centro di Roma...",
"Token_Utilizzati": 123,
"Img_Generata": "iVBORw0KGg...",
"Img_Link": "https://www.multimrktg.com/assets/image/user-12345.png",
"Audio_Generato": "UklGRn5MAAB...",
"Audio_Link": "https://www.multimrktg.com/assets/audio/user-12345.mp3",
"Token_Utilizzati": 123
}

Errori

In caso di errore, l'API restituirà un codice di errore HTTP appropriato e un messaggio di errore in formato JSON. Esempi di errori:

Esempio di messaggio di errore:

{
"error": "Token mancante o non valido"
}

Limitazioni

L'API ha le seguenti limitazioni:

Utilizzo

Per utilizzare questa API, seguire questi passaggi:

  1. Ottenere un Bearer token valido per l'autenticazione dell'utente.
  2. Preparare una richiesta POST all'endpoint dell'API, includendo il Bearer token nell'header Authorization.
  3. Includere nel body della richiesta il prompt di input, il testo per generare l'immagine (opzionale) e la voce per generare l'audio (opzionale).
  4. Inviare la richiesta e gestire la risposta, che conterrà il testo, l'immagine e l'audio generati, insieme ai link alle risorse e al numero di token utilizzati.

Note




Documentazione API VISION

Introduzione

Oltre alla generazione di testo basata su prompt testuali, questa API supporta ora anche la generazione di testo basata su immagini. Gli utenti possono fornire, oltre al prompt testuale, un'immagine in formato base64 come parte della richiesta POST. Questo consente di generare descrizioni, spiegazioni o qualsiasi altro tipo di testo relativo all'immagine fornita.

Requisiti

Per utilizzare questa API, è necessario:

Endpoint

URL: https://multimrktg.com/api/vision
Metodo: POST

Autenticazione

L'autenticazione viene effettuata tramite un Bearer Token. Il token deve essere incluso nell'header della richiesta come segue:

Authorization: Bearer your_bearer_token
    

Parametri della richiesta

Per utilizzare questa funzionalità, è necessario aggiungere il seguente parametro all'oggetto JSON della richiesta:

Esempio di richiesta JSON con immagine:
{
    "prompt": "Crea una descrizione per questa immagine",
    "file": "/9j/4AAQSkZJRgABAQAAAQABAAD...",
}

Elaborazione dell'immagine

La richiesta che include un'immagine viene elaborata in modo da generare una URL temporanea per l'immagine, che viene poi utilizzata per generare il testo relativo all'immagine mediante il modello di linguaggio.

Risposta dell'API estesa

La risposta dell'API segue lo stesso formato della risposta standard, includendo il testo generato che ora può riferirsi all'immagine fornita nella richiesta. Esempio di risposta JSON estesa:

{
    "MrktgAI": "Richiesta autorizzata con successo",
    "Testo_Generato": "L'immagine mostra una spiaggia al tramonto con il mare calmo. Sullo sfondo, si possono vedere delle piccole imbarcazioni...",
    "Token_Utilizzati": 98
}

Utilizzo dell'API in PHP con Immagine Inclusa

<?php

// Inizializza cURL
$ch = curl_init();

// Dati immagine in base64 (questo è solo un esempio, sostituiscilo con la tua immagine codificata in base64)
$image_base64 = 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...';

// Parametri da inviare nella POST request
$postData = [
    "prompt" => "Crea una descrizione per questa immagine",
    "file" => $image_base64, // Aggiungo il parametro 'file' che contiene l'immagine in base64
];

// Imposta le opzioni per la cURL session
curl_setopt($ch, CURLOPT_URL, "https://multimrktg.com/api/vision"); // URL dell'endpoint API
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($postData)); // Passa i dati della richiesta codificati in JSON
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: Bearer your_bearer_token" // Sostituisci con il tuo Bearer Token
]);

// Esegue la richiesta
$response = curl_exec($ch);

// Chiude la cURL session
curl_close($ch);

// Decodifica la risposta JSON
$responseArray = json_decode($response, true);

// Stampa il testo generato basato sull'immagine
if (isset($responseArray['Risposta'])) {
    echo "Testo generato: " . $responseArray['Risposta']. "\n";
} else {
    echo "Si è verificato un errore nella generazione del testo.\n";
}

?>

Gestione degli errori aggiuntivi

In aggiunta ai codici di errore HTTP standard, questa estensione introduce potenziali errori legati al caricamento e alla decodifica delle immagini. Tuttavia, gli errori specifici legati a questa funzionalità verranno comunicati nella stessa maniera degli errori generali, attraverso i codici di errore e messaggi appropriati.

Note

- Il testo generato può variare in termini di lunghezza e qualità a seconda del prompt fornito e delle impostazioni del modello.
- L'API non garantisce una risposta immediata e può richiedere tempo per generare il testo, a seconda della complessità del prompt e delle risorse disponibili.