Completion Messages

Send Completion Message

Available for: Text Generator apps.

Sends a request to a text-generation app and returns the generated text.

post/completion-messages

Request body

CompletionRequest required— unresolved $ref

Response

Successful response. The content type and structure depend on the response_mode parameter in the request.

  • If response_mode is blocking, returns application/json with a CompletionResponse object.
  • If response_mode is streaming, returns text/event-stream with a stream of ChunkCompletionEvent objects.
eventstring

Event type, fixed as message.

task_idstring uuid

Task ID for request tracking and the Stop Completion Message Generation API.

idstring uuid

Unique ID of this response event.

message_idstring uuid

Unique message ID. Use this as the message_id parameter when calling feedback or suggested questions endpoints.

modestring

App mode, fixed as completion.

answerstring

Complete response content.

created_atinteger

Message creation timestamp (Unix epoch seconds).

Changes

No recorded changes to this endpoint across all 10 revisions of this API.