v1

latestOpenAPI 3.0.12026-07-17366.4 KB

Explain the best way to say or do something in a specific situation or context with a foreign language. Use this endpoint when the user asks more general or high-level questions.

post/v1/public/openai/explain-task

Request body

task_descriptionstring required

Description of the task that the user wants to accomplish or do. For example, "tell the waiter they messed up my order" or "compliment someone on their shirt"

learning_languagestring required

The foreign language that the user is learning and asking about. The value can be inferred from question - for example, if the user asks "how do i ask a girl out in mexico city", the value should be "Spanish" because of Mexico City. Always use the full name of the language (e.g. Spanish, French).

native_languagestring required

The user's native language. Infer this value from the language the user asked their question in. Always use the full name of the language (e.g. Spanish, French).

additional_contextstring required

A description of any additional context in the user's question that could affect the explanation - e.g. setting, scenario, situation, tone, speaking style and formality, usage notes, or any other qualifiers.

full_querystring required

Full text of the user's question.

Response

OK

explanationstring

An explanation of the best thing to say in the foreign language to accomplish the task described in the user's question.