Class Messages

files

create

• create(threadId, body, options?): APIPromise<ThreadMessage>

• Create a message.

  Parameters

  • threadId: string

  • body: MessageCreateParams

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<ThreadMessage>

list

• list(threadId, query?, options?): PagePromise<ThreadMessagesPage, ThreadMessage>

• Returns a list of messages for a given thread.

  Parameters

  • threadId: string

  • Optional query: MessageListParams

  • Optional options: RequestOptions<unknown>

  Returns PagePromise<ThreadMessagesPage, ThreadMessage>
• list(threadId, options?): PagePromise<ThreadMessagesPage, ThreadMessage>

• Parameters

  • threadId: string

  • Optional options: RequestOptions<unknown>

  Returns PagePromise<ThreadMessagesPage, ThreadMessage>

retrieve

• retrieve(threadId, messageId, options?): APIPromise<ThreadMessage>

• Retrieve a message.

  Parameters

  • threadId: string

  • messageId: string

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<ThreadMessage>

update

• update(threadId, messageId, body, options?): APIPromise<ThreadMessage>

• Modifies a message.

  Parameters

  • threadId: string

  • messageId: string

  • body: MessageUpdateParams

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<ThreadMessage>