assistant

Ask the assistant

Ask a question about GogoScreen and get an answer, in the same call. Without conversationId a new conversation is started; with one, the question continues that thread. The answer is plain text written from a knowledge base built out of this product's own limits; the assistant has no tools, cannot see anything about any other customer, and cannot change, refund or decide anything about an account — when a question needs a person it says so and sets handoffSuggested. remainingToday is how many more questions this account may ask before the daily cap; null when the cap is off.

post/assistant/messages

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/assistant/messages
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Request body

conversationIdstring uuid

Continue this conversation. Omit to start a new one. A conversation of another account is a 404.

messagestring required

The question, as the customer typed it. Treated as text throughout: it is never part of the assistant's instructions, and credentials or card numbers in it are removed before it is stored.

Response

Ask the assistant

remainingTodayinteger nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.