Vai al contenuto principale
POST
/
v1
/
answers
Antwort erstellen
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 POST /v1/answers consente di creare una nuova risposta nel sistema. Questo è utile per aggiungere risposte personalizzate che possono essere utilizzate in varie parti dell’applicazione.

Richiesta

Corpo della Richiesta

La richiesta deve includere un corpo JSON con i seguenti campi:
  • question: (stringa) La domanda a cui si sta rispondendo.
  • answer: (stringa) La risposta alla domanda.
  • metadata: (oggetto) Dati aggiuntivi relativi alla risposta.

Esempio di Richiesta

{
  "question": "Qual è la capitale d'Italia?",
  "answer": "Roma",
  "metadata": {
    "categoria": "geografia",
    "difficoltà": "facile"
  }
}

Risposta

Corpo della Risposta

Se la richiesta ha successo, la risposta includerà un oggetto JSON con i seguenti campi:
  • id: (stringa) L’identificatore univoco della risposta creata.
  • question: (stringa) La domanda fornita.
  • answer: (stringa) La risposta fornita.
  • metadata: (oggetto) I dati aggiuntivi forniti.

Esempio di Risposta

{
  "id": "12345",
  "question": "Qual è la capitale d'Italia?",
  "answer": "Roma",
  "metadata": {
    "categoria": "geografia",
    "difficoltà": "facile"
  }
}

Errori

In caso di errore, la risposta conterrà un oggetto JSON con un messaggio di errore e un codice di stato HTTP appropriato.

Esempio di Errore

{
  "errore": "Il campo 'question' è obbligatorio.",
  "codice": 400
}

Note

Assicurati che tutti i campi obbligatori siano inclusi nella richiesta per evitare errori.

Autorizzazioni

Authorization
string
header
obbligatorio

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json
task
string
obbligatorio

Die auszuführende Aufgabe.

json_format
object

Das gewünschte Ausgabe-JSON-Objekt mit leeren Werten als Schema oder einfach die Daten, die Sie als String wünschen, beschreiben.

Risposta

Erfolgreiche Antwort mit der Antwort.

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