Skip to main content
POST
/
api
/
v1
/
products
/
{product_id}
/
ask
Ask a question
curl --request POST \
  --url https://api.clarityq.ai/api/v1/products/{product_id}/ask \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "prompt": "<string>"
}
'
{
  "status": "IN_PROGRESS",
  "message": "<string>",
  "conversation_id": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key obtained from the ClarityQ dashboard.

Path Parameters

​
product_id
string<uuid>
required

Body

application/json
​
prompt
string
required

Question to send to the ClarityQ agent.

Response

Successful Response

​
status
enum<string>
required

Current status of the request.

Available options:
IN_PROGRESS,
COMPLETED,
ERROR
​
message
string
required

Human-readable status message.

​
conversation_id
string
required

Conversation ID for tracking the request.