AI Chat

Provide the credential the assistant asked for.

Changed on
put/ai/conversations/{public_id}/secrets/{secret_id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/ai/conversations/{public_id}/secrets/{secret_id}
  • Auth: HTTP bearer

Path parameters

public_idstring required

Conversation public id

secret_idstring required

Secret request id

Request body

valuestring password required

A credential. Write-only: it is never returned, and the AI assistant supplies it through a secret slot instead of typing it into the conversation.

Response

Credential stored; the response never includes it

conversation_idinteger required
created_atstring date-time required
expires_atstring date-time required
fieldstring required

JSON pointer of the request field the value is for.

filled_atstring date-time nullable
idstring required

The id inside the handle (secret_ref:v1:<id>).

labelstring required

What the form asks for.

operation_idstring required
statusstring required

awaiting, filled, cancelled or expired.

Changes