{"openapi":"3.1.0","info":{"title":"Zep (BYOK) API","version":"0.1.0","description":"Zep (BYOK) lets an AI assistant read your own Zep data through the Zep API with a key you supply (Zep project API key). Read-only: 9 tools (list_users, get_user, list_threads, list_user_threads, get_thread_messages, get_thread_summary, list_graphs, list_context_templates, list_graph_ontology). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-zep.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-zep/docs"},"termsOfService":"https://connectorbay.com/byok-zep/terms"},"servers":[{"url":"https://byok-zep.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-zep/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_users":{"post":{"operationId":"list_users","summary":"List the users stored in your Zep project (newest first by default) with their ids, first name and creation time; suppor","description":"List the users stored in your Zep project (newest first by default) with their ids, first name and creation time; supports search and paging. Use for \"Which users exist in my Zep project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results per page (1 to 100).","title":"Page Size"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by text found in the user_id, name or email.","title":"Search"},"order_by":{"anyOf":[{"enum":["created_at","user_id","email"],"type":"string"},{"type":"null"}],"default":"created_at","description":"Sort column: created_at, user_id or email.","title":"Order By"},"asc":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to sort ascending, false for descending.","title":"Asc"}},"title":"list_usersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_user":{"post":{"operationId":"get_user","summary":"Get one Zep user by user_id: name, time zone, creation time and whether the default ontology is disabled. Use for \"Show ","description":"Get one Zep user by user_id: name, time zone, creation time and whether the default ontology is disabled. Use for \"Show Zep user user_1024\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"user_id":{"description":"The user_id of the Zep user (the id your application gave the user), for example 'user_1024'.","maxLength":200,"title":"User Id","type":"string"}},"required":["user_id"],"title":"get_userArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_threads":{"post":{"operationId":"list_threads","summary":"List conversation threads in the project with the user each belongs to and creation time. Use for \"Which conversation th","description":"List conversation threads in the project with the user each belongs to and creation time. Use for \"Which conversation threads does my Zep project have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many threads per page (1 to 100).","title":"Page Size"},"order_by":{"anyOf":[{"enum":["created_at","updated_at","user_id","thread_id"],"type":"string"},{"type":"null"}],"default":"created_at","description":"Order by created_at, updated_at, user_id or thread_id.","title":"Order By"},"asc":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True for ascending order, false for descending.","title":"Asc"}},"title":"list_threadsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_user_threads":{"post":{"operationId":"list_user_threads","summary":"List all conversation threads of one Zep user. Use for \"Which threads does Zep user user_1024 have\".","description":"List all conversation threads of one Zep user. Use for \"Which threads does Zep user user_1024 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"user_id":{"description":"The user_id of the Zep user (the id your application gave the user), for example 'user_1024'.","maxLength":200,"title":"User Id","type":"string"}},"required":["user_id"],"title":"list_user_threadsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_thread_messages":{"post":{"operationId":"get_thread_messages","summary":"Read the messages stored in one thread (role, name, text, time). Use lastn for only the newest messages, or limit with c","description":"Read the messages stored in one thread (role, name, text, time). Use lastn for only the newest messages, or limit with cursor to page. Use for \"What are the latest messages in Zep thread thread-12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"thread_id":{"description":"The thread_id of the conversation thread, for example 'thread-12345'.","maxLength":200,"title":"Thread Id","type":"string"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum number of messages to return.","title":"Limit"},"cursor":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Pagination cursor: the number to continue from.","title":"Cursor"},"lastn":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Return only this many most recent messages (overrides limit and cursor).","title":"Lastn"}},"required":["thread_id"],"title":"get_thread_messagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_thread_summary":{"post":{"operationId":"get_thread_summary","summary":"Get the running summary Zep generated from a thread's messages (404 when none exists yet). Use for \"Summarize Zep thread","description":"Get the running summary Zep generated from a thread's messages (404 when none exists yet). Use for \"Summarize Zep thread thread-12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"thread_id":{"description":"The thread_id of the conversation thread, for example 'thread-12345'.","maxLength":200,"title":"Thread Id","type":"string"}},"required":["thread_id"],"title":"get_thread_summaryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_graphs":{"post":{"operationId":"list_graphs","summary":"List the standalone knowledge graphs in the project (not user graphs) with id, name and description; supports search and","description":"List the standalone knowledge graphs in the project (not user graphs) with id, name and description; supports search and paging. Use for \"Which standalone graphs are in my Zep project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results per page (1 to 100).","title":"Page Size"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by text in graph_id, name or description (up to 200 characters).","title":"Search"},"order_by":{"anyOf":[{"enum":["created_at","graph_id","name"],"type":"string"},{"type":"null"}],"default":"created_at","description":"Sort column: created_at, graph_id or name.","title":"Order By"},"asc":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to sort ascending, false for descending.","title":"Asc"}},"title":"list_graphsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_context_templates":{"post":{"operationId":"list_context_templates","summary":"List the context templates (template id and text) defined in the project. Use for \"Which Zep context templates do I have","description":"List the context templates (template id and text) defined in the project. Use for \"Which Zep context templates do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_context_templatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_graph_ontology":{"post":{"operationId":"list_graph_ontology","summary":"Show the custom entity types and edge types configured for the project's graphs. Use for \"What entity and edge types doe","description":"Show the custom entity types and edge types configured for the project's graphs. Use for \"What entity and edge types does my Zep graph ontology define\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_graph_ontologyArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}