Zep v3

Interact with Zep Cloud v3 API

Actions44

Overview

The "Create Graph" operation in the Zep node allows users to create a new knowledge graph within the Zep Cloud v3 API environment. This graph serves as a structured repository for storing and organizing interconnected data entities, relationships, and facts. Users can define the graph's unique identifier, name, description, and optionally configure instructions for rating the relevance and accuracy of facts within the graph.

This operation is beneficial in scenarios where organizations or developers want to build custom knowledge bases that capture complex relationships between entities, such as customer interaction data, product information, or domain-specific knowledge. For example, a company might create a graph named "Customer Interaction Knowledge Base" to store and analyze interactions, enabling advanced search and insights.

Properties

Name	Meaning
Graph ID	The unique identifier of the graph. It can be provided to specify the graph explicitly; if omitted, the system may generate one.
Graph Name	The display name of the graph. Example: "My Knowledge Graph".
Description	A textual description of the graph's purpose or contents. Example: "A graph containing customer interaction data and knowledge base".
Fact Rating Instruction	Configuration for fact rating instructions, including: - Instruction: Main instruction guiding how facts should be rated (e.g., "Rate facts based on relevance, accuracy, and recency"). - High Rating Example: Example of a highly rated fact. - Medium Rating Example: Example of a moderately rated fact. - Low Rating Example: Example of a low-rated fact.

Output

The output JSON from the "Create Graph" operation contains the response from the Zep Cloud API after creating the graph. Typically, this includes details about the newly created graph such as its unique identifier, name, description, creation timestamps, and any configured fact rating instructions.

The output structure generally looks like:

{
  "graph_id": "string",
  "name": "string",
  "description": "string",
  "fact_rating_instruction": {
    "instruction": "string",
    "examples": {
      "high": "string",
      "medium": "string",
      "low": "string"
    }
  },
  "created_at": "ISO 8601 timestamp",
  ...
}

No binary data is output by this operation.

Dependencies

Requires an API key credential for authenticating with the Zep Cloud v3 API.
The node must be configured with this API key credential in n8n.
Network access to https://api.getzep.com is required.

Troubleshooting

Missing Required Fields: If the Graph Name or Graph ID is missing or invalid, the API may return an error. Ensure these fields are correctly set.
Authentication Errors: If the API key credential is missing or invalid, authentication will fail. Verify the API key configuration.
Fact Rating Instruction Format: If the fact rating instruction is malformed or incomplete, the API might reject it. Provide complete and valid instruction examples.
API Rate Limits: Excessive requests may lead to rate limiting errors. Implement retry logic or reduce request frequency.
Network Issues: Connectivity problems to the Zep API endpoint will cause failures. Check network settings and firewall rules.

Common error messages include:

"Unauthorized": Indicates invalid or missing API credentials.
"Bad Request": Usually due to missing or invalid parameters.
"Too Many Requests": Rate limit exceeded; wait before retrying.

Resolving these typically involves verifying input parameters, ensuring correct API credentials, and handling retries appropriately.