Vai al contenuto principale
POST
/
v1
/
answers
Crea Risposta
curl --request POST \
  --url https://api.olostep.com/v1/answers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "task": "<string>",
  "json_format": {}
}
'
{
  "id": "<string>",
  "object": "<string>",
  "created": 123,
  "metadata": {},
  "task": "<string>",
  "result": {
    "json_content": "<string>",
    "json_hosted_url": "<string>"
  }
}

​
Introduzione

L’endpoint Crea Risposta ti permette di creare una nuova risposta nel sistema. Questo è utile quando hai bisogno di aggiungere risposte programmaticamente.

​
Richiesta

Per creare una risposta, invia una richiesta POST all’endpoint /v1/answers con il payload JSON appropriato.

​
Corpo della Richiesta

Il corpo della richiesta deve contenere i seguenti campi:
  • question: La domanda a cui questa risposta si riferisce.
  • answer: Il testo della risposta.
  • metadata: (opzionale) Informazioni aggiuntive sulla risposta.

​
Esempio di Richiesta

{
  "question": "Qual è la capitale d'Italia?",
  "answer": "Roma",
  "metadata": {
    "source": "Enciclopedia"
  }
}

​
Risposta

Se la richiesta è riuscita, il server restituirà una risposta con codice di stato 201 Created, insieme ai dettagli della risposta appena creata.

​
Esempio di Risposta

{
  "id": "12345",
  "question": "Qual è la capitale d'Italia?",
  "answer": "Roma",
  "metadata": {
    "source": "Enciclopedia"
  },
  "created_at": "2023-10-01T12:00:00Z"
}

​
Errori

Se c’è un problema con la richiesta, il server restituirà un codice di stato di errore e un messaggio di errore descrittivo.

​
Esempi di Errori

  • 400 Bad Request: Il corpo della richiesta è malformato o mancano campi obbligatori.
  • 401 Unauthorized: Non hai l’autorizzazione per creare risposte.
  • 500 Internal Server Error: Si è verificato un errore imprevisto sul server.

​
Note

Assicurati di avere le autorizzazioni necessarie per utilizzare questo endpoint. Consulta la documentazione sull’autenticazione per ulteriori dettagli.

Autorizzazioni

​
Authorization
string
header
obbligatorio

Header di autenticazione Bearer nella forma Bearer , dove è il tuo token di autenticazione.

Corpo

application/json
​
task
string
obbligatorio

Il compito da eseguire.

​
json_format
object

L'oggetto JSON di output desiderato con valori vuoti come schema, o semplicemente descrivi i dati che vuoi come stringa.

Risposta

Risposta riuscita con la risposta.

​
id
string
​
object
string
​
created
integer
​
metadata
object
​
task
string
​
result
object