Add thread messages

POST

https://api.getzep.com/api/v4/threads/:thread_uuid/messages

POST

/api/v4/threads/:thread_uuid/messages

from zep_cloud import Zep, AddMessage
client = Zep(
    api_key="YOUR_API_KEY_HERE",
)
client.thread.add_messages(
    thread_uuid="thread_uuid",
    messages=[
        AddMessage()
    ],
)

{
  "context": "string",
  "messages": [
    {
      "content": "string",
      "created_at": "string",
      "metadata": {},
      "name": "string",
      "processed": true,
      "role": "system",
      "thread_uuid": "string",
      "uuid": "string"
    }
  ],
  "task": {
    "completed_at": "string",
    "created_at": "string",
    "error": {
      "code": "string",
      "details": {},
      "message": "string",
      "param": "string",
      "request_id": "string"
    },
    "progress": {
      "stage": "string"
    },
    "result": {},
    "started_at": "string",
    "status": "string",
    "type": "string",
    "updated_at": "string",
    "uuid": "string"
  }
}

Authentication

AuthorizationApi-Key

Type "Api-Key" followed by a space and the project API key.

Path parameters

thread_uuidstringRequired

Thread UUID

Request

Request body

messageslist of objectsRequired

The messages to add to the thread.

ignore_roleslist of stringsOptional

Message roles to skip during graph extraction; the messages are still stored.

return_contextbooleanOptional

When true, returns the context block for the thread's most recent messages.

strict_ontologybooleanOptional

When true, prevents extraction of generic entity nodes that do not match the configured ontology.

Response

Accepted

contextstringOptional

The context block assembled from the graph after adding the messages, present only when return_context is true in the request.

messageslist of objectsOptional

The messages that were added, each including its assigned identifier.

taskobjectOptional

The asynchronous task that tracks the messages' graph extraction and indexing.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error