Ask Request

POST 
/ask

Interact with the WordLift Agent to process a message and receive an AI-driven response.

Request

application/json

Body

required

message Message (string)required
model Model (string)

Default value: gpt-4o

security Security (boolean)

Responses

200

Successful Response

application/json

Schema

Schema

response Response (string)required

Example (from schema)

{
  "response": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}