TsgcHTTP_API_OpenAI › Methods › CreateMessage

CreateMessage Method

Appends a new message to an existing Thread

Syntax

function CreateMessage(const aThreadId: string; const aRequest: TsgcOpenAIClass_Request_Message): TsgcOpenAIClass_Message;

Parameters

Name	Type	Description
aThreadId	const string	The identifier of the Thread that will receive the message.
aRequest	const TsgcOpenAIClass_Request_Message	Message to append: Role (usually user), Content, optional attachments and metadata.

Return Value

The created Message object with its generated id and timestamp (TsgcOpenAIClass_Message)

Remarks

Calls POST /v1/threads/{thread_id}/messages to append a user or assistant message to the Thread. Attachments may reference uploaded files and specify the tools (file_search, code_interpreter) that should use them. After one or more messages have been added, launch a Run with CreateRun to produce an Assistant reply.

Example

var oRequest: TsgcOpenAIClass_Request_Message;
begin
  oRequest := TsgcOpenAIClass_Request_Message.Create;
  try
    oRequest.Role := 'user';
    oRequest.Content := 'Solve 2x + 3 = 11';
    oAPI.CreateMessage('thread_abc123', oRequest);
  finally
    oRequest.Free;
  end;
end;

Back to Methods