Skip to content

Conversations API Reference ​

Complete API documentation for the Conversation model and methods.

Model Properties ​

PropertyTypeDescription
idintegerUnique identifier
conversable_typestringPolymorphic relation type
conversable_idintegerPolymorphic relation ID
titlestringConversation title
metadatajsonAdditional metadata
created_attimestampCreation timestamp
updated_attimestampLast update timestamp
deleted_attimestampSoft delete timestamp

Methods ​

Message Creation ​

php
addUserMessage(string $content, array $metadata = []): Conversation
addAssistantMessage(string $content, array $metadata = []): Conversation
addSystemMessage(string $content, array $metadata = []): Conversation
addToolCallMessage(string $content, array $metadata = []): Conversation
addToolResultMessage(string $content, array $metadata = []): Conversation

Direct Message Creation ​

php
createUserMessage(string $content, array $metadata = []): Message
createAssistantMessage(string $content, array $metadata = []): Message
createSystemMessage(string $content, array $metadata = []): Message
createToolCallMessage(string $content, array $metadata = []): Message
createToolResultMessage(string $content, array $metadata = []): Message

Relationships ​

php
messages(): HasMany
messageChunks(): HasManyThrough
conversationable(): MorphTo

Released under the MIT License.