{"openapi":"3.0.0","info":{"title":"Virtual Agent","description":"Zoom Virtual Agent APIs enable you to build artificial intelligence (AI) and chatbot solutions for your website. \n\n Your website users can expect immediate responses to their queries at any time. As a result, Zoom Virtual Agent deploys support to your users faster and reduces the workload for your live agents. \n\n All endpoints are available through `https` at `api.zoom.us/v2/`.","termsOfService":"https://zoom.us/docs/en-us/zoom_api_license_and_tou.html","contact":{"name":"Zoom Developers","url":"https://developer.zoom.us/"},"version":"2"},"externalDocs":{"description":"Find out more about Swagger","url":"https://swagger.io"},"servers":[{"url":"https://api.zoom.us/v2"}],"paths":{"/km/kbs/{kbId}/articles":{"get":{"tags":["Knowledge Management"],"summary":"Get articles","description":"Returns multiple knowledge base articles.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:km_kbs`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_km_articles`,`zva:read:list_km_articles:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"GetArticles","parameters":[{"name":"kbId","in":"path","description":"The ID of the knowledge base","required":true,"schema":{"type":"string","description":"The ID of the knowledge base.","example":"whelb0q6qe1bpqg6jrw3ismo"}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"e9je7r6yxfqlaklt7zz4wzh9"}},{"name":"page_size","in":"query","description":"The number of records returned per page.","required":false,"schema":{"maximum":300,"type":"number","description":"The number of records returned per page.","example":30,"default":30}},{"name":"include_contents","in":"query","description":"Whether to include the contents of the article in the response or not.","required":false,"schema":{"type":"boolean","description":"Whether to include the contents of the article in the response or not.","example":false,"default":false}},{"name":"excluded","in":"query","description":"Whether to query excluded articles or not.","required":false,"schema":{"type":"boolean","description":"Whether to query excluded articles or not.","example":false,"default":false}},{"name":"language","in":"query","description":"The language of the results.","required":false,"schema":{"type":"string","example":"en-US","enum":["zh-CN","zh-TW","en-US","en-GB","en-AU","en-NZ","fr-FR","fr-CA","pt-PT","pt-BR","es-ES","es-US","es-MX","da-DK","nl-NL","nl-BE","en-CA","fr-BE","fr-LU","de-DE","de-AT","de-CH","it-IT","ja-JP","ko-KR","no-NO","pl-PL","ro-RO","ru-RU","sv-SE","tr-TR"]}}],"responses":{"200":{"description":"The list of the returned articles.","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","nullable":true,"example":"e9je7r6yxfqlaklt7zz4wzh9"},"page_size":{"maximum":300,"type":"number","description":"The number of records returned within a single API call.","example":30,"default":30},"total_records":{"type":"number","description":"The total number of all the records available across pages.","example":100},"articles":{"maxItems":300,"type":"array","description":"The list or articles from the knowledge base","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the article.","example":"e9je7r6yxfqlaklt7zz4wzh9"},"external_id":{"type":"string","description":"The external ID of the article.","nullable":true,"example":"871b707a-7756-46b6-bfba-36a297ba1e85"},"kb_id":{"type":"string","description":"The ID of the knowledge base.","example":"whelb0q6qe1bpqg6jrw3ismo"},"category":{"type":"string","description":"The category of the article.","nullable":true,"example":"Foo"},"title":{"type":"string","description":"The title of the article.","example":"Article One"},"url":{"pattern":"^https?://.+","type":"string","description":"The URL of the article.","format":"uri","nullable":true,"example":"https://example.com/foo/article1"},"content":{"type":"string","description":"The content of the article.","example":"

article 1 content with some html

"},"created_at":{"type":"string","description":"The date and time the article was created.","format":"date-time","example":"2023-05-12T16:31:22.265Z"},"updated_at":{"type":"string","description":"The date and time the article was last updated.","format":"date-time","example":"2023-05-12T21:01:14.07Z"},"exclude":{"type":"boolean","description":"Whether the article is excluded from being presented as a solution to queries.","example":false,"default":false},"language":{"type":"string","description":"The language of the article.","example":"en-US","enum":["zh-CN","zh-TW","en-US","en-GB","en-AU","en-NZ","fr-FR","fr-CA","pt-PT","pt-BR","es-ES","es-US","es-MX","da-DK","nl-NL","nl-BE","en-CA","fr-BE","fr-LU","de-DE","de-AT","de-CH","it-IT","ja-JP","ko-KR","no-NO","pl-PL","ro-RO","ru-RU","sv-SE","tr-TR"]}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `33001`
\n Specified KB is not type Custom API.
\n**Error Code:** `33005`
\n Validation failed.
\n"},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `33000`
\n The knowledge base was not found.
\n"},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva:read:km_kbs","zva:read:list_km_articles","zva:read:list_km_articles:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["ZoomKnowledgeBaseKnowledgeBases:Read","AIStudioKnowledgeBases:Read"],"x-macro-scopes":["zva:read:km_kbs"],"x-granular-scopes":["zva:read:list_km_articles","zva:read:list_km_articles:admin"]}},"post":{"tags":["Knowledge Management"],"summary":"Create article","description":"Creates a knowledge base article.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:write:km_kbs`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:write:km_article`,`zva:write:km_article:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"CreateArticle","parameters":[{"name":"kbId","in":"path","description":"The knowledge base's ID.","required":true,"schema":{"type":"string","example":"whelb0q6qe1bpqg6jrw3ismo"}}],"requestBody":{"description":"Creates a knowledge base article.","content":{"application/json":{"schema":{"required":["content","exclude","title"],"type":"object","properties":{"category":{"type":"string","description":"The article's category.","example":"Foo"},"title":{"type":"string","description":"The article's title.","example":"My Article 1"},"url":{"type":"string","description":"The article's URL.","example":"https://example.com/foo/article1"},"content":{"type":"string","description":"The article's content.","example":"<p>article 1 content with <b>some</b> <i>html</i></p>"},"exclude":{"type":"boolean","description":"This field excludes the article from being presented as a solution to queries.","example":false},"language":{"type":"string","description":"The article's language.","example":"en-US","enum":["zh-CN","zh-TW","en-US","en-GB","en-AU","en-NZ","fr-FR","fr-CA","pt-PT","pt-BR","es-ES","es-US","es-MX","da-DK","nl-NL","nl-BE","en-CA","fr-BE","fr-LU","de-DE","de-AT","de-CH","it-IT","ja-JP","ko-KR","no-NO","pl-PL","ro-RO","ru-RU","sv-SE","tr-TR"]},"external_id":{"type":"string","description":"The article's external ID.","example":"871b707a-7756-46b6-bfba-36a297ba1e85"}}}}}},"responses":{"201":{"description":"Article has been created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The article's ID.","example":"c6o8l4m5xxyyaz0kxiqec6v6"},"kb_id":{"type":"string","description":"The knowledge base's ID.","example":"whelb0q6qe1bpqg6jrw3ismo"},"category":{"type":"string","description":"The category of the article.","example":"Foo"},"title":{"type":"string","description":"The title of the article.","example":"Article One"},"url":{"type":"string","description":"The article's URL.","example":"https://example.com/foo/article1"},"created_at":{"type":"string","description":"The date and time the article was created.","format":"date-time","example":"2023-03-21T20:21:30.659Z"},"updated_at":{"type":"string","description":"The date and time the article was last updated.","format":"date-time","example":"2023-03-21T20:21:30.659Z"},"exclude":{"type":"boolean","description":"This field excludes the article from being presented as a solution to queries.","example":false},"language":{"type":"string","description":"The article's language.","example":"en-US","enum":["zh-CN","zh-TW","en-US","en-GB","en-AU","en-NZ","fr-FR","fr-CA","pt-PT","pt-BR","es-ES","es-US","es-MX","da-DK","nl-NL","nl-BE","en-CA","fr-BE","fr-LU","de-DE","de-AT","de-CH","it-IT","ja-JP","ko-KR","no-NO","pl-PL","ro-RO","ru-RU","sv-SE","tr-TR"]},"external_id":{"type":"string","description":"The article's external ID.","example":"871b707a-7756-46b6-bfba-36a297ba1e85"},"content":{"type":"string","description":"The article's content.","example":"

article 1 content with some html

"}}}}}},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `33001`
\n Specified KB is not type Custom API.
\n**Error Code:** `33002`
\n Too many articles for KB (limit is 5000).
\n**Error Code:** `33005`
\n Validation failed.
\n"},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `33000`
\n The knowledge base was not found.
\n"},"409":{"description":"**HTTP Status Code:** `409`
\n Conflict \n\n **Error Code:** `33003`
\n An article for this KB already exists with external ID \"871b707a-7756-46b6-bfba-36a297ba1e85\" and language \"en\".
\n"},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva:write:km_kbs","zva:write:km_article","zva:write:km_article:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["ZoomKnowledgeBaseKnowledgeBases:Edit","AIStudioKnowledgeBases:Edit"],"x-macro-scopes":["zva:write:km_kbs"],"x-granular-scopes":["zva:write:km_article","zva:write:km_article:admin"]}}},"/km/kbs/{kbId}/articles/{articleId}":{"get":{"tags":["Knowledge Management"],"summary":"Get article","description":"Returns a knowledge base article.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:km_kbs`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:km_article`,`zva:read:km_article:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"GetArticle","parameters":[{"name":"kbId","in":"path","description":"The ID of the knowledge base.","required":true,"schema":{"type":"string","example":"whelb0q6qe1bpqg6jrw3ismo"}},{"name":"articleId","in":"path","description":"The ID of the article.","required":true,"schema":{"type":"string","example":"c6o8l4m5xxyyaz0kxiqec6v6"}}],"responses":{"200":{"description":"The returned article.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the article.","example":"c6o8l4m5xxyyaz0kxiqec6v6"},"kb_id":{"type":"string","description":"The ID of the knowledge base.","example":"whelb0q6qe1bpqg6jrw3ismo"},"category":{"type":"string","description":"The category of the article.","example":"Foo"},"title":{"type":"string","description":"The title of the article.","example":"Article One"},"url":{"type":"string","description":"The URL of the article's URL.","example":"https://example.com/foo/article1"},"created_at":{"type":"string","description":"The date and time the article was created.","format":"date-time","example":"2023-03-21T20:21:30.659Z"},"updated_at":{"type":"string","description":"The date and time the article was last updated.","format":"date-time","example":"2023-03-21T20:21:30.659Z"},"exclude":{"type":"boolean","description":"This field excludes the article from being presented as a solution to queries.","example":false},"language":{"type":"string","description":"The language of the article.","example":"en-US","enum":["zh-CN","zh-TW","en-US","en-GB","en-AU","en-NZ","fr-FR","fr-CA","pt-PT","pt-BR","es-ES","es-US","es-MX","da-DK","nl-NL","nl-BE","en-CA","fr-BE","fr-LU","de-DE","de-AT","de-CH","it-IT","ja-JP","ko-KR","no-NO","pl-PL","ro-RO","ru-RU","sv-SE","tr-TR"]},"external_id":{"type":"string","description":"The external ID of the article. ","example":"871b707a-7756-46b6-bfba-36a297ba1e85"},"content":{"type":"string","description":"The content of the article.","example":"

article 1 content with some html

"}}}}}},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `33001`
\n Specified KB is not type Custom API.
\n**Error Code:** `33005`
\n Validation failed.
\n"},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `33000`
\n The knowledge base was not found.
\n**Error Code:** `33004`
\n The article was not found.
\n"},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva:read:km_kbs","zva:read:km_article","zva:read:km_article:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["ZoomKnowledgeBaseKnowledgeBases:Read","AIStudioKnowledgeBases:Read"],"x-macro-scopes":["zva:read:km_kbs"],"x-granular-scopes":["zva:read:km_article","zva:read:km_article:admin"]}},"put":{"tags":["Knowledge Management"],"summary":"Update article","description":"Updates a knowledge base article.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:write:km_kbs`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:update:km_article`,`zva:update:km_article:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"UpdateArticle","parameters":[{"name":"kbId","in":"path","description":"The knowledge base's ID.","required":true,"schema":{"type":"string","example":"whelb0q6qe1bpqg6jrw3ismo"}},{"name":"articleId","in":"path","description":"The ID of the article.","required":true,"schema":{"type":"string","example":"c6o8l4m5xxyyaz0kxiqec6v6"}}],"requestBody":{"description":"This field updates a knowledge base article.","content":{"application/json":{"schema":{"required":["content","exclude","title"],"type":"object","properties":{"category":{"type":"string","description":"The category of the article.","example":"Foo"},"title":{"type":"string","description":"The title of the article.","example":"My Article 1"},"url":{"type":"string","description":"The URL of the article.","example":"https://example.com/foo/article1"},"content":{"type":"string","description":"The content of the article.","example":"<p>article 1 content with <b>some</b> <i>html</i></p>"},"exclude":{"type":"boolean","description":"This field excludes the article from being presented as a solution to queries.","example":false,"default":false},"language":{"type":"string","description":"The language article.","example":"en-US","enum":["zh-CN","zh-TW","en-US","en-GB","en-AU","en-NZ","fr-FR","fr-CA","pt-PT","pt-BR","es-ES","es-US","es-MX","da-DK","nl-NL","nl-BE","en-CA","fr-BE","fr-LU","de-DE","de-AT","de-CH","it-IT","ja-JP","ko-KR","no-NO","pl-PL","ro-RO","ru-RU","sv-SE","tr-TR"]},"external_id":{"type":"string","description":"The external ID of the article.","example":"871b707a-7756-46b6-bfba-36a297ba1e85"}}}}}},"responses":{"200":{"description":"The updated article.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the article.","example":"c6o8l4m5xxyyaz0kxiqec6v6"},"kb_id":{"type":"string","description":"The ID of the knowledge base.","example":"whelb0q6qe1bpqg6jrw3ismo"},"category":{"type":"string","description":"The category of the article.","example":"Foo"},"title":{"type":"string","description":"The title of the article.","example":"Article One"},"url":{"type":"string","description":"The URL of the article.","example":"https://example.com/foo/article1"},"created_at":{"type":"string","description":"The date and time the article was created.","format":"date-time","example":"2023-03-21T20:21:30.659Z"},"updated_at":{"type":"string","description":"The date and time the article was last updated.","format":"date-time","example":"2023-03-21T20:21:30.659Z"},"exclude":{"type":"boolean","description":"This field excludes the article from being presented as a solution to queries.","example":false},"language":{"type":"string","description":"The language of the article.","example":"en-US","enum":["zh-CN","zh-TW","en-US","en-GB","en-AU","en-NZ","fr-FR","fr-CA","pt-PT","pt-BR","es-ES","es-US","es-MX","da-DK","nl-NL","nl-BE","en-CA","fr-BE","fr-LU","de-DE","de-AT","de-CH","it-IT","ja-JP","ko-KR","no-NO","pl-PL","ro-RO","ru-RU","sv-SE","tr-TR"]},"external_id":{"type":"string","description":"The external ID of the article.","example":"871b707a-7756-46b6-bfba-36a297ba1e85"},"content":{"type":"string","description":"The content of the article.","example":"

article 1 content with some html

"}}}}}},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `33001`
\n Specified KB is not type Custom API.
\n**Error Code:** `33005`
\n Validation failed.
\n"},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `33000`
\n The knowledge base was not found.
\n**Error Code:** `33004`
\n The article was not found.
\n"},"409":{"description":"**HTTP Status Code:** `409`
\n Conflict \n\n **Error Code:** `33003`
\n An article for this KB already exists with external ID \"871b707a-7756-46b6-bfba-36a297ba1e85\" and language \"en\".
\n"},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva:write:km_kbs","zva:update:km_article","zva:update:km_article:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["ZoomKnowledgeBaseKnowledgeBases:Edit","AIStudioKnowledgeBases:Edit"],"x-macro-scopes":["zva:write:km_kbs"],"x-granular-scopes":["zva:update:km_article","zva:update:km_article:admin"]}},"delete":{"tags":["Knowledge Management"],"summary":"Delete article","description":"Deletes a knowledge base article.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:write:km_kbs`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:delete:km_article`,`zva:delete:km_article:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"DeleteArticle","parameters":[{"name":"kbId","in":"path","description":"The ID of the knowledge base.","required":true,"schema":{"type":"string","example":"whelb0q6qe1bpqg6jrw3ismo"}},{"name":"articleId","in":"path","description":"The ID of the article.","required":true,"schema":{"type":"string","example":"c6o8l4m5xxyyaz0kxiqec6v6"}}],"responses":{"204":{"description":"The article is deleted."},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `33001`
\n Specified KB is not type Custom API.
\n**Error Code:** `33005`
\n Validation failed.
\n"},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `33000`
\n The knowledge base was not found.
\n**Error Code:** `33004`
\n The article was not found.
\n"},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva:write:km_kbs","zva:delete:km_article","zva:delete:km_article:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["ZoomKnowledgeBaseKnowledgeBases:Edit","AIStudioKnowledgeBases:Edit"],"x-macro-scopes":["zva:write:km_kbs"],"x-granular-scopes":["zva:delete:km_article","zva:delete:km_article:admin"]}}},"/km/kbs/{kbId}/sync":{"post":{"tags":["Knowledge Management"],"summary":"Create sync request","description":"Creates a sync request for the specified knowledge base\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:write:km_kbs`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:update:km_kb:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"CreateSyncRequest","parameters":[{"name":"kbId","in":"path","description":"The knowledge base's ID.","required":true,"schema":{"type":"string","example":"whelb0q6qe1bpqg6jrw3ismo"}}],"requestBody":{"description":"Creates a sync request for the specified knowledge base."},"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"required":["error_code","error_message","progress_percent","started_at","sync_status"],"type":"object","properties":{"sync_id":{"type":"string","description":"The sync ID.","example":"a6w6izgus3qlxz6di0vsrv8s"},"kb_id":{"type":"string","description":"The knowledge base's ID.","example":"whelb0q6qe1bpqg6jrw3ismo"},"sync_status":{"type":"string","description":"The status of the sync.","example":"IN_PROGRESS","enum":["QUEUED","PENDING","IN_PROGRESS","COMPLETED","FAILED","ABORTING","ABORTED"]},"progress_percent":{"type":"integer","description":"The percent progress of the sync.","nullable":true,"example":50},"error_code":{"type":"integer","description":"The numerical error code of reason why sync failed (otherwise null).","nullable":true,"example":33009,"enum":[33009,33008,33010,33007]},"error_message":{"type":"string","description":"The error message of the reason why a sync failed (otherwise null).","nullable":true,"example":"The sync failed because no articles had any content."},"created_at":{"type":"string","description":"The time the sync request was created (in ISO 8601 format).","format":"date-time","example":"2025-01-08T13:00:00Z"},"updated_at":{"type":"string","description":"The type the sync progress or status was last updated (in ISO 8601 format).","format":"date-time","example":"2025-01-08T13:00:00Z"},"started_at":{"type":"string","description":"The time the sync started (in ISO 8601 format).","format":"date-time","nullable":true,"example":"2025-01-10T13:00:00Z"}}}}}},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request Bad Request \n\n **Error Code:** `33001`
\n Specified KB is not type Custom API.
\n**Error Code:** `33013`
\n The knowledge base is not enabled
\n**Error Code:** `33005`
\n Validation failed.
\n"},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found Not Found \n\n **Error Code:** `33000`
\n The knowledge base was not found.
\n"},"409":{"description":"**HTTP Status Code:** `409`
\n Conflict Conflict \n\n **Error Code:** `33011`
\n A sync is already in progress
\n**Error Code:** `33012`
\n A sync has completed too recently
\n"},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva:write:km_kbs","zva:update:km_kb:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["ZoomKnowledgeBaseKnowledgeBases:Edit","AIStudioKnowledgeBases:Edit"],"x-macro-scopes":["zva:write:km_kbs"],"x-granular-scopes":["zva:update:km_kb:admin"]}}},"/km/kbs/{kbId}/sync/{syncId}":{"get":{"tags":["Knowledge Management"],"summary":"Get sync","description":"Returns the details of a knowledge base sync.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:km_kbs`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:km_kb:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"GetSync","parameters":[{"name":"kbId","in":"path","description":"The ID of the knowledge base.","required":true,"schema":{"type":"string","example":"whelb0q6qe1bpqg6jrw3ismo"}},{"name":"syncId","in":"path","description":"The ID of the sync request.","required":true,"schema":{"type":"string","example":"a6w6izgus3qlxz6di0vsrv8s"}}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"required":["error_code","error_message","progress_percent","started_at","sync_status"],"type":"object","properties":{"sync_id":{"type":"string","description":"The sync ID.","example":"a6w6izgus3qlxz6di0vsrv8s"},"kb_id":{"type":"string","description":"The knowledge base's ID.","example":"whelb0q6qe1bpqg6jrw3ismo"},"sync_status":{"type":"string","description":"The status of the sync.","example":"IN_PROGRESS","enum":["QUEUED","PENDING","IN_PROGRESS","COMPLETED","FAILED","ABORTING","ABORTED"]},"progress_percent":{"type":"integer","description":"The percent progress of the sync.","nullable":true,"example":50},"error_code":{"type":"integer","description":"The numerical error code of reason why sync failed (otherwise null).","nullable":true,"example":33009,"enum":[33009,33008,33010,33007]},"error_message":{"type":"string","description":"The error message of reason why sync failed (otherwise null).","nullable":true,"example":"The sync failed because no articles had any content"},"created_at":{"type":"string","description":"The time the sync request was created (in ISO 8601 format).","format":"date-time","example":"2025-01-10T13:00:00Z"},"updated_at":{"type":"string","description":"The type the sync progress or status was last updated (in ISO 8601 format).","format":"date-time","example":"2025-01-10T13:00:00Z"},"started_at":{"type":"string","description":"The time the sync started (in ISO 8601 format).","format":"date-time","nullable":true,"example":"2025-01-12T15:00:00Z"}}}}}},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found Default Response \n\n **Error Code:** `33014`
\n The knowledge base or sync request was not found
\n"}},"security":[{"openapi_oauth":["zva:read:km_kbs","zva:read:km_kb:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["ZoomKnowledgeBaseKnowledgeBases:Read","AIStudioKnowledgeBases:Read"],"x-macro-scopes":["zva:read:km_kbs"],"x-granular-scopes":["zva:read:km_kb:admin"]}}},"/virtual_agent/report/engagements":{"get":{"tags":["Report"],"summary":"Get ZVA engagements","description":"Generates a list of ZVA engagements.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_engagements:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetZVAEngagements","parameters":[{"name":"from","in":"query","description":"The **beginning** of the query's date range. This timestamp represents the **earliest engagement end time** that will be included in the results in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. If *from* is not provided, the API returns data from the past 24 hours. When *from* is provided, the system returns up to one month of data, filtered based on engagement end time.","required":false,"schema":{"type":"string","format":"date","example":"2023-07-01"}},{"name":"to","in":"query","description":"The **end** of the query's date range. This timestamp represents the latest **engagement end time** that will be included in the results in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. **Required only when *from* is provided.** Defines the upper bound of the date window, based on engagement end time.","required":false,"schema":{"type":"string","format":"date","example":"2023-07-02"}},{"name":"timezone","in":"query","description":"The call's [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). The default is **UTC**.","required":false,"schema":{"type":"string","example":"UTC"}},{"name":"page_size","in":"query","description":"The number of items returned per page.\nConstraints: Maximum - 100, default - 10","required":false,"schema":{"maximum":100,"type":"integer","example":10,"default":10}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"}},{"name":"include_query_detail","in":"query","description":"Whether the engagement response includes query details.","required":false,"schema":{"type":"boolean","example":false,"deprecated":true}},{"name":"agent_types","in":"query","description":"A list of (comma-separated) agent types. The default value is **chat**.","required":false,"schema":{"maxItems":3,"type":"array","example":["chat","ai_voice","ai_chat"],"items":{"type":"string","enum":["chat","ai_voice","ai_chat"]}}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`
ZVA engagements successfully returned.","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"},"page_size":{"maximum":100,"type":"integer","description":"The number of records returned within a single API call.\nConstraints: Max: 100 Default: 10","example":10,"default":10},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":44},"timezone":{"type":"string","description":"The call's [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). The default is **UTC**.","example":"UTC"},"engagements":{"maxItems":100,"type":"array","description":"The information about the engagements.","items":{"type":"object","properties":{"engagement_id":{"type":"string","description":"The engagement's ID.","example":"NF1kPajwRCGa9-cgHWGAQw"},"start_time":{"type":"string","description":"The engagement's start time and date in **yyyy-MM-dd'T'HH:mm:ss'Z'** format.","format":"date-time","example":"2023-07-11T22:17:49Z"},"duration":{"type":"integer","description":"The duration of the engagement in seconds.","example":25},"campaign_name":{"type":"string","description":"The engagement's campaign name.","example":"campaignA"},"global_variables":{"type":"array","description":"The information about the engagement's global variables. Marked for removal. Recommended to use the new **Variables API** instead.","deprecated":true,"items":{"type":"object","properties":{"type":{"type":"string","description":"The global variable's type.","example":"system"},"value":{"type":"string","description":"The global variable's value.","example":"value A"},"group_name":{"type":"string","description":"The global variable's group name.","example":"group A"},"group_id":{"type":"string","description":"The global variable's group ID.","example":"1688149024708"},"variable_name":{"type":"string","description":"The global variable's name.","example":"variable A"},"variable_id":{"type":"string","description":"The global variable's ID.","example":"h9NNoHkwTrqEEiQ3e8ATOw"},"need_mask":{"type":"boolean","description":"If the global variable needs a mask.","example":true},"need_store":{"type":"boolean","description":"If the global variable needs a store.","example":true}},"description":"The engagement's global variables."}},"outcome":{"type":"string","description":"The outcome of the engagement.","example":"assistanceRequested"},"launch_url":{"type":"string","description":"The URL of the transcript of the engagement, such as a link to the transcript as a secured embeddable web page.\n","example":"https://zoom.us"},"query_summary":{"type":"object","properties":{"query_ids":{"type":"array","description":"The engagement's query IDs.","items":{"type":"string","description":"The engagement's query ID.","example":"kkvuqwaosrm9itxqthxirq"}},"count":{"type":"integer","description":"The total count of the engagement's query IDs.","example":12}},"description":"The summary of queries in an engagement.","deprecated":true},"intent_summary":{"type":"object","properties":{"intents_matched":{"type":"array","description":"The matched custom intents in the engagement.","items":{"type":"object","properties":{"intent_id":{"type":"string","description":"The intent's ID","example":"sbyW0BwLTUSKGzDsqcfnCQ"},"intent_name":{"type":"string","description":"The intent's name.","example":"Contact Support copy"},"intent_type":{"type":"string","description":"The intent's type. \n* `custom_intent`\n* `small_talk`\n* `default_intent`\n* FAQ","example":"faq","default":"default_intent","enum":["custom_intent","small_talk","default_intent","faq"]},"accuracy":{"type":"number","description":"The intent's accuracy, from 0 to 1. 0.5 means this intent has 50% accuracy.","example":0.5},"system_intent":{"type":"boolean","description":"Whether this record belongs to the system intent.","example":true}},"description":"The engagement's bot intent."}},"count":{"type":"integer","description":"The total count of the matched engagement's intents.","example":10}},"description":"The summary of the matched custom intents in the engagement."},"language_code":{"type":"string","description":"The language code for the engagement.","example":"en-US","default":"en-US","enum":["en-GB","en-US","ar","da-DK","de-DE","es-ES","es-MX","fr-CA","fr-FR","it-IT","ja","ko-KR","nl-NL","pt-BR","pt-PT","ru","zh-CN","zh-HK"]},"query_details":{"type":"array","description":"The engagement's query details.","deprecated":true,"items":{"type":"object","properties":{"query_id":{"type":"string","description":"The query's ID.","example":"0b883910-0783-4383-9dcf-b5c9ba315438"},"engagement_id":{"type":"string","description":"The engagement's ID.","example":"ioknax-4siqztcqwga0xug"},"bot_id":{"type":"string","description":"The bot's ID that the engagement uses.","example":"FZOKnPjmTse9ISSvQN4Zjg"},"bot_session_id":{"type":"string","description":"The bot session's ID.","example":"ioknax-4siqztcqwga0xug"},"query_time":{"type":"string","description":"The date and time when the query started in ISO 8601 format (**yyyy-MM-dd'T'HH:mm:ss'Z'** or **yyyy-MM-dd'T'HH:mm:ss**).","format":"date-time","example":"2023-07-11T22:17:49Z"},"language_code":{"type":"string","description":"The language code for the query.","example":"en-US","default":"en-US","enum":["en-GB","en-US","ar","da-DK","de-DE","es-ES","es-MX","fr-CA","fr-FR","it-IT","ja","ko-KR","pt-BR","pt-PT","ru","zh-CN","zh-HK","nl-NL"]},"query_text":{"type":"string","description":"The query's text.","example":"Route 1"},"intents":{"type":"array","description":"The intents associated with the query.","items":{"type":"object","properties":{"intent_id":{"type":"string","description":"The intent's ID","example":"sbyW0BwLTUSKGzDsqcfnCQ"},"intent_name":{"type":"string","description":"The intent's name.","example":"Contact Support copy"},"intent_type":{"type":"string","description":"The intent's type. \n* `custom_intent`\n* `small_talk`\n* `default_intent`\n* FAQ","example":"faq","default":"default_intent","enum":["custom_intent","small_talk","default_intent","faq"]},"accuracy":{"type":"number","description":"The intent's accuracy. From 0 to 1. (e.g. 0.5 means this intent has 50% accuracy.)","example":0.5},"system_intent":{"type":"boolean","description":"Whether this record belongs to the system intent.","example":true}},"description":"The top intent associated with the query."}},"articles":{"type":"array","description":"The query's articles.","items":{"type":"object","properties":{"id":{"type":"string","description":"The article's ID.","example":"-0zryh7dTEyY9HADPHm_dA"},"title":{"type":"string","description":"The article's title.","example":"Can I edit my chat welcome screen?"},"answer":{"type":"string","description":"The article's answer.","example":"Yes, you can customize the following settings for the chat welcome screen."},"url":{"type":"string","description":"The article's URL.","example":"https://docs.google.com/"},"score":{"type":"number","description":"The article's socre, from 0 to 1.","example":0.5},"kb_details":{"type":"array","description":"The article's knowledge base detail list.","items":{"type":"object","properties":{"kb_id":{"type":"string","description":"The knowledge base's ID.","example":"-0zryh7dTEyY9HADPHm_dA"},"kb_name":{"type":"string","description":"The knowledge base's name.","example":"default knowledge base"},"kb_groups":{"type":"array","description":"The article's knowledge base group.","items":{"type":"object","properties":{"id":{"type":"string","description":"The knowledge base group ID.","example":"2"},"name":{"type":"string","description":"The knowledge base group name.","example":"default name"}},"description":"The knowledge base group."}}},"description":"The article's knowledge base details."}}},"description":"The top knowledge base article associated with the query."}}},"description":"The query details."}},"end_time":{"type":"string","description":"The engagement's end time and date in **yyyy-MM-dd'T'HH:mm:ss'Z'** format.","format":"date-time","example":"2023-07-12T22:17:49Z"},"consumer_id":{"type":"string","description":"The consumer iD of the engagement","example":"KuwgnuP7RgSJAN3Kjaw_uQ"},"deleted":{"type":"boolean","description":"Whether the status engagement is deleted or not.","example":true},"agents":{"type":"array","description":"This list of agents involved in this engagement","items":{"type":"object","properties":{"agent_type":{"type":"string","description":"The type of the agent used in the engagement.","example":"AI_VOICE","enum":["AI_VOICE","AI_CHAT","CHAT"]},"agent_id":{"type":"string","description":"The internal ID of the agent.","example":"QF0l7by1TfuIteSJfleVdg"},"agent_name":{"type":"string","description":"The agent name entered by the user.","example":"HappyBot AI Agent"},"agent_version_id":{"type":"string","description":"Internal version ID of AI agent.","example":"Mn8m2c4ERrWrzZ9SqjNHMQ"},"agent_version_number":{"type":"integer","description":"Version number of AI agent.","example":8}},"description":"AI Agent details"}},"tools":{"type":"array","description":"The list of tools AI agent used in this engagement.","items":{"type":"string","description":"The name of the tool AI agent used in this engagement.","example":"End_Conversation"}},"skills":{"type":"array","description":"The list of skills AI agent invoked in this engagement.","items":{"type":"string","description":"The name of the skill AI agent used in this engagement.","example":"Route_To_Demo"}},"articles":{"type":"array","description":"The list of articles AI agent used in this engagement.","items":{"type":"string","description":"The title of the article AI agent used in this engagement.","example":"Can I edit my chat welcome screen?"}},"topics":{"type":"array","description":"The list of topics AI agent detected in this engagement.","items":{"type":"string","description":"The name of the topic AI agent used in this engagement.","example":"Weather Inquiry"}},"last_responder":{"type":"string","description":"The entity that responded the last in this conversation.","example":"Consumer","enum":["AI Agent","Consumer","Chatbot"]},"interaction_duration":{"type":"integer","description":"The total number of seconds of interaction between the AI agent and the consumer.","example":25},"interaction_turns":{"type":"integer","description":"The total number of conversation exchanges between the Consumer and AI Agent.","example":7},"escalation_reason":{"type":"string","description":"Whether the escalation was requested or by design. **Marked for removal at the end of January 2026.**","example":"Escalation requested","deprecated":true,"enum":["Escalation by design","Escalation requested"]},"user_phone_number":{"type":"string","description":"The phone number of the user.","example":"+12097899000"},"source_types":{"type":"array","description":"The list of sources from where the engagement originates.","items":{"type":"string","description":"The enum value for the source type.","example":"ZCC_AI_AGENT","enum":["ZCC","ZCC_AI_AGENT","ZP","AMAZON","GENESYS","WEB_SDK","WEB_SDK_SIMULATOR","WEB_SDK_PREVIEW","WEB_SDK_AI_AGENT","WEB_SDK_AI_AGENT_PREVIEW","MOBILE","MOBILE_AGENT","TEAM_CHAT_BETA","TEAM_CHAT_CHANNEL","ZECO","ZECO_HEADLESS","CHAT","WHATSAPP","SMS","TEAM_CHAT","FACEBOOK_MESSENGER","INSTAGRAM"]}},"transfer_accepted":{"type":"boolean","description":"Whether the transfer was accpeted by the agent or not.","example":true},"implicit_resolution":{"type":"string","description":"Whether the consumer's issue was implicitly resolved by the virtual agent. **This is field is available only if it is enabled for the account.**","example":"RESOLVED","enum":["RESOLVED","NOT_RESOLVED"]},"agent_messages_sent":{"type":"integer","description":"Number of messages sent by the Virtual Agent during the conversation.","example":3},"consumer_messages_sent":{"type":"integer","description":"Number of messages sent by the consumer during the conversation.","example":2}},"description":"The single engagement that returns."}},"from":{"type":"string","description":"The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, it returns data from the past 24 hours.","format":"date-time","example":"2023-07-01T00:00:00Z"},"to":{"type":"string","description":"**Required** only when the **from** parameters is specified. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the **from** parameter.","format":"date-time","example":"2023-07-02T23:59:59Z"}}}}}},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request \n\n "},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva_report:read","zva_report:read:admin","zva:read:list_engagements:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zva_report:read","zva_report:read:admin"],"x-granular-scopes":["zva:read:list_engagements:admin"]}}},"/virtual_agent/report/engagements/query_details":{"get":{"tags":["Report"],"summary":"Get ZVA query details","description":"Returns a list of ZVA engagement query details.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_queries:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetZVAQueryDetails","parameters":[{"name":"from","in":"query","description":"The **beginning** of the query's date range. This timestamp represents the **earliest engagement end time** that will be included in the results in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. If *from* is not provided, the API returns data from the past 24 hours. When *from* is provided, the system returns up to one month of data, filtered based on engagement end time.","required":false,"schema":{"type":"string","format":"date","example":"2023-07-01"}},{"name":"to","in":"query","description":"The **end** of the query's date range. This timestamp represents the latest **engagement end time** that will be included in the results in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. **Required only when *from* is provided.** Defines the upper bound of the date window, based on engagement end time.","required":false,"schema":{"type":"string","format":"date","example":"2023-07-02"}},{"name":"timezone","in":"query","description":"The call's [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). The default is **UTC**.","required":false,"schema":{"type":"string","example":"UTC"}},{"name":"page_size","in":"query","description":"The number of items returned per page. \nConstraints: Max: 100 Default: 10","required":false,"schema":{"maximum":100,"type":"integer","example":10,"default":10}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"}},{"name":"engagement_ids","in":"query","description":"The engagement IDs string separated by \",\". Up limit is 2000 characters.","required":false,"schema":{"type":"string","example":"N-ecLZBoS-ayCabdwDQSrA,MDP1xR_CQ0eJzHmPT9jOUA"}},{"name":"agent_types","in":"query","description":"A list of (comma-separated) agent types. Default value is **chat**.","required":false,"schema":{"maxItems":3,"type":"array","example":["chat","ai_voice","ai_chat"],"items":{"type":"string","enum":["chat","ai_voice","ai_chat"]}}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`
ZVA engagement query details successfully returned.","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","description":"The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, it returns data from the past 24 hours.","format":"date-time","example":"2023-07-01T00:00:00Z"},"to":{"type":"string","description":" This field is **required** only when the **from** parameter is specified. The end time and date is in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, which is the same format as the **from** parameter.","format":"date-time","example":"2023-07-02T23:59:59Z"},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"},"page_size":{"maximum":100,"type":"integer","description":"The number of records returned within a single API call. Constraints: Max: 100 Default: 10","example":10,"default":10},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":22},"timezone":{"type":"string","description":"The call's [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). The default is **UTC**.","example":"UTC"},"engagement_query_details":{"maxItems":100,"type":"array","description":"The list for the engagement query details.","items":{"type":"object","properties":{"engagement_id":{"type":"string","description":"The engagement's ID.","example":"NF1kPajwRCGa9-cgHWGAQw"},"query_details":{"type":"array","description":"The query details list that belong to the engagement.","items":{"type":"object","properties":{"query_id":{"type":"string","description":"The query's ID.","example":"0b883910-0783-4383-9dcf-b5c9ba315438"},"bot_id":{"type":"string","description":"The bot's ID that the query uses. This field is available only when the agent type in the engagement is **CHAT**.","example":"FZOKnPjmTse9ISSvQN4Zjg"},"bot_name":{"type":"string","description":"The bot's name. This field is available only when the agent type in the engagement is **CHAT**.","example":"Chatbot"},"bot_session_id":{"type":"string","description":"The bot session's ID. This field is available only when the agent type in the engagement is **CHAT**.","example":"ioknax-4siqztcqwga0xug"},"query_time":{"type":"string","description":"The date and time when the query started in ISO 8601 format (**yyyy-MM-dd'T'HH:mm:ss'Z'** or **yyyy-MM-dd'T'HH:mm:ss**).","format":"date-time","example":"2023-07-11T22:17:49Z"},"language_code":{"type":"string","description":"The language code for the query.","example":"en-US","default":"en-US","enum":["en-GB","en-US","ar","da-DK","de-DE","es-ES","es-MX","fr-CA","fr-FR","it-IT","ja","ko-KR","pt-BR","pt-PT","ru","zh-CN","zh-HK","nl-NL"]},"query_text":{"type":"string","description":"The query's text.","example":"Route 1"},"intents":{"type":"array","description":"The intents associated with the query.","items":{"type":"object","properties":{"intent_id":{"type":"string","description":"The intent's ID.","example":"sbyW0BwLTUSKGzDsqcfnCQ"},"intent_name":{"type":"string","description":"The intent's name.","example":"Contact Support copy"},"intent_type":{"type":"string","description":"The intent's type.","example":"faq","default":"default_intent","enum":["custom_intent","small_talk","default_intent","faq"]},"accuracy":{"type":"number","description":"The intent's accuracy. From 0 to 1. (e.g. 0.5 means this intent has 50% accuracy.)","example":0.5},"system_intent":{"type":"boolean","description":"Whether this record belongs to the system intent.","example":false,"default":true}},"description":"The top intent associated with the query."}},"articles":{"type":"array","description":"The query's articles.","items":{"type":"object","properties":{"article_id":{"type":"string","description":"The article's ID.","example":"-0zryh7dTEyY9HADPHm_dA"},"article_title":{"type":"string","description":"The article's title.","example":"Can I edit my chat welcome screen?"},"article_answer":{"type":"string","description":"The article's answer.","example":"Yes, you can customize the following settings for the chat welcome screen.","deprecated":true},"article_url":{"type":"string","description":"The article's URL.","example":"https://docs.google.com/"},"is_helpful":{"type":"boolean","description":"Whether the article is helpful.","example":true},"article_score":{"type":"number","description":"The article's score from 0 to 1.","example":0.5},"kb_details":{"type":"array","description":"The list for the article's knowledge base details.","items":{"type":"object","properties":{"kb_id":{"type":"string","description":"The knowledge base's ID.","example":"0zryh7dTEyY9HADPHm_dA"},"kb_name":{"type":"string","description":"The knowledge base's name.","example":"default knowledge base"},"kb_groups":{"type":"array","description":"The article's knowledge base group.","deprecated":true,"items":{"type":"object","properties":{"group_id":{"type":"string","description":"The knowledge base group ID.","example":"2"},"group_name":{"type":"string","description":"The knowledge base group name.","example":"default name"}},"description":"The knowledge base group."}}},"description":"The article's knowledge base detail."}},"helpful_response":{"type":"string","description":"Whether the article is helpful.","example":"No Response","enum":["Yes","No","No Response"]}},"description":"The top knowledge base article associated with the query."}},"deleted":{"type":"boolean","description":"Whether the status query is deleted or not.","example":true},"topic_name":{"type":"string","description":"The name of the topic used in the query.","example":"Check refund status"},"agent_id":{"type":"string","description":"The ID of the agent used in the query. This field is available only when the agent type in the engagement is either **AI_VOICE** or **AI_CHAT**.","example":"jSeZPyVUQamm7WSVZWpExA"},"agent_name":{"type":"string","description":"The name of the agent in the query. This field is available only when the agent type in the engagement is either **AI_VOICE** or **AI_CHAT**.","example":"HappyBot Agent"},"agent_type":{"type":"string","description":"The type of the agent used in the query. This field is available only when the agent type in the engagement is either **AI_VOICE** or **AI_CHAT**.","example":"AI_VOICE","enum":["AI_VOICE","AI_CHAT"]},"agent_session_id":{"type":"string","description":"The session ID of the agent in the query. This field is available only when the agent type in the engagement is either **AI_VOICE** or **AI_CHAT**.","example":"vXd6K1SPSz2WSTz0t3wuRg"}},"description":"The query's detail."}}},"description":"The object for the engagement query details."}}}}}}},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `1002`
\n Unable to fetch query details.
\n"},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `1001`
\n Engagement does not exist: $engagement_ids
\n"},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva_report:read","zva_report:read:admin","zva:read:list_queries:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zva_report:read","zva_report:read:admin"],"x-granular-scopes":["zva:read:list_queries:admin"]}}},"/virtual_agent/report/engagements/variables":{"get":{"tags":["Report"],"summary":"Get ZVA variable details","description":"Get a list of ZVA engagement variable details.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_variables:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetZVAengagementvariabledetails","parameters":[{"name":"from","in":"query","description":"The **beginning** of the query's date range. This timestamp represents the **earliest engagement end time** that will be included in the results in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. If *from* is not provided, the API returns data from the past 24 hours. When *from* is provided, the system returns up to one month of data, filtered based on engagement end time.","required":false,"schema":{"type":"string","format":"date","example":"2023-07-01"}},{"name":"to","in":"query","description":"The **end** of the query's date range. This timestamp represents the latest **engagement end time** that will be included in the results in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. **Required only when *from* is provided.** Defines the upper bound of the date window, based on engagement end time.","required":false,"schema":{"type":"string","format":"date","example":"2023-07-02"}},{"name":"timezone","in":"query","description":"The call's [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). The default is **UTC**.","required":false,"schema":{"type":"string","example":"UTC"}},{"name":"page_size","in":"query","description":"The number of items returned per page. \nConstraints: Max: 100 Default: 10","required":false,"schema":{"maximum":100,"type":"integer","example":10,"default":10}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"}},{"name":"engagement_ids","in":"query","description":"The engagement IDs string separated by \",\". Up limit is 2000 characters.","required":false,"schema":{"maxLength":2000,"type":"string","example":"N-ecLZBoS-ayCabdwDQSrA,MDP1xR_CQ0eJzHmPT9jOUA"}},{"name":"agent_types","in":"query","description":"The list of (comma-separated) agent types. The default value is **chat**.","required":false,"schema":{"maxItems":3,"type":"array","example":["chat","ai_voice","ai_chat"],"items":{"type":"string","enum":["chat","ai_voice","ai_chat"]}}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`
ZVA engagement variable details successfully returned.","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","description":"The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, it returns data from the past 24 hours.","format":"date-time","example":"2023-07-01T00:00:00Z"},"to":{"type":"string","description":" This field is **required** only when the **from** parameter is specified. The end time and date is in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, which is the same format as the **from** parameter.","format":"date-time","example":"2023-07-02T23:59:59Z"},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"},"page_size":{"maximum":100,"type":"integer","description":"The number of records returned within a single API call. Constraints: Max: 100 Default: 10","example":10,"default":10},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":22},"timezone":{"type":"string","description":"The call's [timezone ID](https://developers.zoom.us/docs/api/references/abbreviations/#timezones). The default is **UTC**.","example":"UTC"},"engagement_variable_details":{"type":"array","description":"The list of engagements and its variable details.","items":{"type":"object","properties":{"engagement_id":{"type":"string","description":"The engagement ID.","example":"G9wepeWxQAO7o0M6AJw2AA"},"variable_details":{"type":"array","description":"The list of variable details belonging to the given engagement ID.","items":{"type":"object","properties":{"variable_id":{"type":"string","description":"The ID of the variable.","example":"f15c3714-4c24-4fc1-b4e6-4f0702b5398f8b2a93e9-3125-4044-8cd6-06ce7f582de8"},"type":{"type":"string","description":"The type of the variable. Type Array and Json are not stored.","example":"Number","enum":["String","Number","Boolean","DateTime","Currency","Percent","Email","URL","Phone","CustomEntity","SystemEntity"]},"name":{"type":"string","description":"The name of the variable.","example":"startTime"},"value":{"type":"string","description":"The value of the variable. It is always a **string**.","example":"1736866627040"},"need_mask":{"type":"boolean","description":"Whether the value of the variable needs masking to protect sensitive data.","example":true},"group_id":{"type":"string","description":"The ID of the group to which the variable belongs to.","example":"1fb58719-22f3-439f-88e2-96c069347331"},"group_name":{"type":"string","description":"The name of the group to which the variable belongs to.","example":"Engagement"},"submitted_at":{"type":"string","description":"The date and time stamp when the variable was submitted during the engagement in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format.","example":"2025-11-04T02:46:45Z"}}}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `1002`
\n Unable to fetch variable details
\n"},"401":{"description":"**HTTP Status Code:** `401`
\n Unauthorized Missing or invalid authentication \n\n "},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `1001`
\n Engagement does not exist: $engagement_ids
\n"},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva_report:read","zva_report:read:admin","zva:read:list_variables:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zva_report:read","zva_report:read:admin"],"x-granular-scopes":["zva:read:list_variables:admin"]}}},"/virtual_agent/report/surveys":{"get":{"tags":["Report"],"summary":"Get ZVA Surveys","description":"Returns a list of ZVA engagement surveys.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_surveys:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetZVASurveys","parameters":[{"name":"from","in":"query","description":"The **beginning** of the query's date range. This timestamp represents the **earliest engagement end time** that will be included in the results in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. If *from* is not provided, the API returns data from the past 24 hours. When *from* is provided, the system returns up to one month of data, filtered based on engagement end time.","required":false,"schema":{"type":"string","format":"date","example":"2025-10-01"}},{"name":"to","in":"query","description":"The **end** of the query's date range. This timestamp represents the latest **engagement end time** that will be included in the results in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. **Required only when *from* is provided.** Defines the upper bound of the date window, based on engagement end time.","required":false,"schema":{"type":"string","format":"date","example":"2025-10-29"}},{"name":"timezone","in":"query","description":"The call's [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). The default is **UTC**.","required":false,"schema":{"type":"string","example":"UTC"}},{"name":"page_size","in":"query","description":"The number of items returned per page. \nConstraints: Max: 100 Default: 10","required":false,"schema":{"maximum":100,"type":"integer","example":10,"default":10}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"}},{"name":"engagement_ids","in":"query","description":"A string of engagement IDs separated by \",\". Up limit is 2000 characters.","required":false,"schema":{"maxLength":2000,"type":"string","example":"N-ecLZBoS-ayCabdwDQSrA,MDP1xR_CQ0eJzHmPT9jOUA"}},{"name":"agent_types","in":"query","description":"The list of (comma-separated) agent types. The default value is **chat**.","required":false,"schema":{"maxItems":3,"type":"array","example":["chat","ai_voice","ai_chat"],"items":{"type":"string","enum":["chat","ai_voice","ai_chat"]}}},{"name":"survey_ids","in":"query","description":"A string of survey IDs separated by \",\". Up limit is 2000 characters.","required":false,"schema":{"maxLength":2000,"type":"string","example":"r8DUXy4BSbO-UQ5ylOUyLg"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`
ZVA engagement surveys successfully returned.","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","description":"The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, it returns data from the past 24 hours.","format":"date-time","example":"2025-10-01T00:00:00Z"},"to":{"type":"string","description":"This field is **required** only when the **from** parameter is specified. The end time and date is in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, which is the same format as the **from** parameter.","format":"date-time","example":"2025-10-29T23:59:59Z"},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"},"page_size":{"maximum":100,"type":"integer","description":"The number of records returned within a single API call. Constraints: Max: 100 Default: 10","example":10,"default":10},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":30},"timezone":{"type":"string","description":"The call's [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). The default is **UTC**.","example":"UTC"},"surveys":{"type":"array","description":"The list of surveys.","items":{"type":"object","properties":{"survey_id":{"type":"string","description":"The ID of the survey.","example":"r8DUXy4BSbO-UQ5ylOUyLg"},"survey_name":{"type":"string","description":"The name of the survey.","example":"voice survey"},"engagement_id":{"type":"string","description":"The engagement ID of the survey.","example":"N-ecLZBoS-ayCabdwDQSrA"},"agent_type":{"type":"string","description":"The type of the virtual agent.","example":"Voice"},"virtual_agent":{"type":"string","description":"The name of the virtual agent.","example":"voice agent"},"consumer":{"type":"string","description":"The name of the consumer.","example":"consumer"},"start_time":{"type":"string","description":"The start time of the survey.","example":"2025-09-03T05:52:22Z"},"submitted_time":{"type":"string","description":"The submitted time of the survey.","example":"2025-09-03T05:55:22Z"},"results":{"type":"array","description":"The results of the survey.","items":{"type":"object","properties":{"question":{"type":"string","description":"A question in the survey.","example":"What color do you like?"},"answer":{"type":"string","description":"The answer to the question.","example":"green"}}}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request Unable to fetch survey results. \n\n "},"401":{"description":"**HTTP Status Code:** `401`
\n Unauthorized Missing or invalid authentication. \n\n "},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found Survey results do not exist. \n\n "},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva_report:read","zva_report:read:admin","zva:read:list_surveys:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zva_report:read","zva_report:read:admin"],"x-granular-scopes":["zva:read:list_surveys:admin"]}}},"/virtual_agent/report/transcripts":{"get":{"tags":["Report"],"summary":"Get ZVA transcripts","description":"Generates a list of ZVA transcripts.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_transcripts:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetZVATranscripts","parameters":[{"name":"from","in":"query","description":"The **beginning** of the query's date range. This timestamp represents the **earliest engagement end time** that will be included in the results in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. If *from* is not provided, the API returns data from the past 24 hours. When *from* is provided, the system returns up to one month of data, filtered based on engagement end time.","required":false,"schema":{"type":"string","format":"date-time","example":"2023-07-01T00:00:00Z"}},{"name":"to","in":"query","description":"The **end** of the query's date range. This timestamp represents the latest **engagement end time** that will be included in the results in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. **Required only when *from* is provided.** Defines the upper bound of the date window, based on engagement end time.","required":false,"schema":{"type":"string","format":"date-time","example":"2023-07-02T23:59:59Z"}},{"name":"timezone","in":"query","description":"The call's [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). The default is **UTC**.","required":false,"schema":{"type":"string","example":"UTC"}},{"name":"page_size","in":"query","description":"The number of items returned per page.\nConstraints: Maximum - 100, default - 10","required":false,"schema":{"maximum":100,"type":"integer","example":10,"default":10}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"}},{"name":"engagement_ids","in":"query","description":"The engagement IDs string separated by \",\". The limit is 2000 characters.","required":false,"schema":{"maxLength":2000,"type":"string","example":"N-ecLZBoS-ayCabdwDQSrA,MDP1xR_CQ0eJzHmPT9jOUA"}},{"name":"agent_types","in":"query","description":"A list of (comma-separated) agent types. The default value is **chat**.","required":false,"schema":{"maxItems":3,"type":"array","example":["chat","ai_voice","ai_chat"],"items":{"type":"string","enum":["chat","ai_voice","ai_chat"]}}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`
ZVA transcripts successfully returned.","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"},"page_size":{"maximum":100,"type":"integer","description":"The number of records returned within a single API call. Constraints: Maximum - 100, Default - 10","example":10,"default":10},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":44},"timezone":{"type":"string","description":"The call's [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones). The default is **UTC**.","example":"UTC"},"transcripts":{"maxItems":100,"type":"array","description":"The information about the transcripts.","items":{"type":"object","properties":{"engagement_id":{"type":"string","description":"The engagement's ID.","example":"akNPVkF0ShCG-X5dY2Nd0Q"},"channel":{"type":"string","description":"The engagement's channel type.","example":"Chat Agent","enum":["Chat Agent","Voice Agent","Classic ChatBot"]},"start_time":{"type":"string","description":"The engagement's start time and date in **yyyy-MM-dd'T'HH:mm:ss'Z'** format.","format":"date-time","example":"2023-07-11T22:17:30Z"},"total_duration":{"type":"integer","description":"The duration of the engagement in seconds.","example":25},"interaction_duration":{"type":"integer","description":"The total number of seconds of interaction between the AI agent and the consumer.","example":20},"end_time":{"type":"string","description":"The engagement's end time and date in **yyyy-MM-dd'T'HH:mm:ss'Z'** format.","format":"date-time","example":"2023-07-12T22:17:55Z"},"messages":{"type":"array","description":"A list of messages.","items":{"type":"object","properties":{"sender":{"type":"string","description":"The sender of the message.","example":"AI Agent","enum":["AI Agent","Bot","Consumer"]},"timestamp":{"type":"string","description":"The message sent time and date in **yyyy-MM-dd'T'HH:mm:ss'Z'** format.","format":"date-time","example":"2023-07-12T22:17:49Z"},"message_type":{"type":"string","description":"The Ttpe of the message.","example":"text"},"text":{"type":"string","description":"The message content.","example":"Message in the conversation"},"kb_articles":{"type":"array","description":"A list of knowledge base articles involved in generating the message.","items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the article.","example":"Creating and Scheduling Meetings."},"url":{"type":"string","description":"The article URL.","example":"https://support.zoom.com/article_1"}}}}}}}}}},"from":{"type":"string","description":"The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The defined date range should be a month, as the response only includes one month's worth of data. If no start date is specified, returns data from the past 24 hours.","format":"date-time","example":"2023-07-01T00:00:00Z"},"to":{"type":"string","description":"**Required** only when the **from** parameter is specified. The end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, in the same format as the **from** parameter.","format":"date-time","example":"2023-07-02T23:59:59Z"}}}}}},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request Unable to fetch Transcripts. \n\n "},"401":{"description":"**HTTP Status Code:** `401`
\n Unauthorized Missing or invalid authentication. \n\n "},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found Transcripts do not exist. \n\n "},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva_report:read","zva_report:read:admin","zva:read:list_transcripts:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zva_report:read","zva_report:read:admin"],"x-granular-scopes":["zva:read:list_transcripts:admin"]}}},"/ai_studio/reports/operation_logs":{"get":{"tags":["Reports"],"summary":"List AI Management operation logs","description":"List AI Management operation logs.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva_report:read`,`zva_report:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zva:read:list_operation_logs:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"ListAIManagementOperationLogs","parameters":[{"name":"from","in":"query","description":"The `from` value must be in `yyyy-MM-dd` or `yyyy-MM-ddTHH:mm:ssZ` format. When omitted together with `to`, the current day is used as the default range.","required":false,"schema":{"pattern":"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])(?:T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ)?$","type":"string","nullable":false,"example":"2026-01-01"}},{"name":"to","in":"query","description":"The `to` value must be in `yyyy-MM-dd` or `yyyy-MM-ddTHH:mm:ssZ` format. Must be provided together with `from`. The window must not exceed one month.","required":false,"schema":{"pattern":"^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])(?:T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ)?$","type":"string","nullable":false,"example":"2026-02-01"}},{"name":"category_filter_key","in":"query","description":"Optional category filter. Must be a recognized category name.","required":false,"schema":{"type":"string","example":"ZVA_AI_AGENT","enum":["INTEGRATIONS","PREFERENCES","GLOBAL_VARIABLE","GLOBAL_VARIABLE_GROUP","EXPERT_ASSIST","EXPERT_ASSIST_AGENT","ASSERT_MANAGER","BOT_MANAGEMENT","VOICE_BOT_MANAGEMENT","BOT_FLOW","VOICE_BOT_FLOW","WEB_CAMPAIGN","INTENT_MANAGEMENT","SUBSCRIPTIONS","SUPPORT_CHANNEL","KNOWLEDGE_BASE","ANALYTICS","HELP_CENTER","CUSTOM_AI_AGENT","ZVA_AI_AGENT","AI_TOOLS","COMMON_AI_AGENT","CUSTOM_DICTIONARY","ANNOTATION_LABEL","ANNOTATION_RECORD","UNKNOWN","AGENT_ASSIST"]}},{"name":"action_filter_key","in":"query","description":"Optional action filter. Must be a recognized action name.","required":false,"schema":{"type":"string","example":"UPDATE_AI_TOOL","enum":["SUBSCRIBE","PUBLISH","UNPUBLISH","EDIT_INTENT","ADD_CAMPAIGN","DELETE_CAMPAIGN","UPDATE_CAMPAIGN","GET_CAMPAIGN_INFO","UPDATE_CAMPAIGN_STATUS","UPDATE_CAMPAIGN_TAG","ADD_CAMPAIGN_TAG","DELETE_CAMPAIGN_TAG","UPDATE_CAMPAIGN_INVITATION","DELETE_CAMPAIGN_INVITATION","UPDATE_CAMPAIGN_LOCATION","DELETE_CAMPAIGN_LOCATION","UPDATE_CAMPAIGN_ENGAGEMENT_WINDOW","ADD_CAMPAIGN_INVITATION","ADD_CAMPAIGN_LOCATION","ADD_CAMPAIGN_ENGAGEMENT_WINDOW","DELETE_CAMPAIGN_ENGAGEMENT_WINDOW","ADD_CAMPAIGN_PROACTIVE_MESSAGE","UPDATE_CAMPAIGN_PROACTIVE_MESSAGE","ADD_CAMPAIGN_FONT","GENERATE_CAMPAIGN_PREVIEW_TOKEN","ADD_OUTBOUND_CAMPAIGN","DELETE_OUTBOUND_CAMPAIGN","UPDATE_OUTBOUND_CAMPAIGN","ADD_CHATBOT","EDIT_CHATBOT","DELETE_CHATBOT","PUBLISHED_CHATBOT","UNPUBLISHED_CHATBOT","ADD_VOICE_BOT","EDIT_VOICE_BOT","DELETE_VOICE_BOT","PUBLISHED_VOICE_BOT","UNPUBLISHED_VOICE_BOT","EDIT_AUTOMATIC_BOT_RESPONSES","EDIT_INTENT_DOMAIN","EDIT_KNOWLEDGE_BASE","EDIT_SUPPORT_CHANNELS","ADD_BOT_FLOW","EDIT_BOT_FLOW","ADD_VOICE_BOT_FLOW","EDIT_VOICE_BOT_FLOW","EDIT_BOT_FLOW_STATUS","PUBLISHED_BOT_FLOW","UNPUBLISHED_BOT_FLOW","DELETE_BOT_FLOW","ADD_ASSET","EDIT_ASSET","ARCHIVED_ASSET","EDIT_WIDGETS_DISPLAY_NAME_AVATAR","CHANGED_TYPING_DELAY","ADDED_VERIFIED_SUBDOMAIN","EDITED_VERIFIED_SUBDOMAIN","DELETED_VERIFIED_SUBDOMAIN","ADD_ENTRY_ID","DELETE_ENTRY_ID","ADD_CUSTOM_VARIABLE_GROUP","EDIT_CUSTOM_VARIABLE_GROUP","DELETE_CUSTOM_VARIABLE_GROUP","ADD_VARIABLE","ADD_VARIABLE_WITH_GROUPNAME","DELETE_VARIABLE","EDITED_VARIABLE","ADD_SUPPORT_CHANNEL","EDIT_SUPPORT_CHANNEL","PAUSE_SUPPORT_CHANNEL","DELETE_SUPPORT_CHANNEL","ADD_DOMAIN","EDIT_DOMAIN","DELETE_DOMAIN","EDIT_DOMAIN_NAME","EDIT_DOMAIN_DESCRIPTION","EDIT_INTENTS_IN_DOMAIN","REVERT_DOMAIN","DOMAIN_STATUS_CHANGE","ADD_INTENT","DELETE_INTENT","ADD_INTENT_TRAINING_PHRASES","EDIT_INTENT_TRAINING_PHRASES","DELETE_INTENT_TRAINING_PHRASES","EDIT_INTENT_NAME","EDIT_INTENT_DESCRIPTION","INTENT_STATUS_CHANGE","ADD_INTENT_RULE","EDIT_INTENT_RULE","DELETE_INTENT_RULE","ADD_INTENT_TO_DOMAIN","EDIT_INTENT_TO_DOMAIN","DELETE_INTENT_TO_DOMAIN","ADD_ENTITY","ADD_VARIANTS","EDIT_ENTITY","EDIT_VARIANTS","DELETE_ENTITY","DELETE_VARIANTS","ADD_VARIANTS_TO_TRAINING_PHRASES","EDIT_VARIANTS_TO_TRAINING_PHRASES","DELETE_VARIANTS_TO_TRAINING_PHRASES","CHANGE_ENTITY_STATUS","COACH_CREATE_NEW_INTENT","COACH_ADD_TO_EXISTING_INTENT","DISCOVER_CREATE_NEW_INTENT","DISCOVER_ADD_TO_EXISTING_INTENT","ADD_KNOWLEDGE_BASE","DELETE_KNOWLEDGE_BASE","RECRAWL","VIEW_KNOWLEDGE_BASE","ADD_GROUP","EDIT_GROUP","DELETE_GROUP","SET_INACTIVE","SET_ACTIVE","VIEW_KB","COACHED","View","PUBLISHED_ASSET","DELETE_ASSET","RESTORE_ASSET","REQUEST_DATA_FILE","DOWNLOAD_DATA_FILE","ADD_SUBSCRIPTION","EDIT_SUBSCRIPTION","DELETE_SUBSCRIPTION","DELETE_SUGGESTION","STATUS_CHANGE","ADD_INTENT_MANAGER_GROUP","EDIT_INTENT_MANAGER_GROUP","DELETE_INTENT_MANAGER_GROUP","EDIT_GROUP_SETTINGS","IM_INTENT_SUGGESTION_UPDATE","IM_PERFORMANCE_EVALUATION_INFO","IM_PERFORMANCE_EVALUATION_DISMISS","IM_PERFORMANCE_UPDATE_BATCH","IM_PERFORMANCE_DELETE","IM_PERFORMANCE_EVALUATION_GENERATE","IM_GROUP_ADD_INTENT","IM_GROUP_INTENTS_CSV_IMPORT","IM_GROUP_AUTO_GENERATE_INTENTS_RETRY","IM_GROUP_DELETE_INTENT","IM_GROUP_DELETE_INTENT_WARNING","IM_GROUP_TRAIN","IM_GROUP_COPY_INTENT","IM_GROUP_PUBLISH","IM_GROUP_SUGGESTION_ROLLBACK","IM_GROUP_IMPORT_GROUP","IM_DISCOVER_NEW_INTENT_V2","IM_ENTITY_ADD","IM_ENTITY_UPDATE","IM_ENTITY_PATTERN_TEST","IM_COACH_OPERATE_QUERIES","IM_INTENT_RULE_UPDATE_ORDER","IM_INTENT_RULE_UPDATE_CONTENT","IM_INTENT_RULE_DELETE","EXPERT_ASSIST_CREATE_INSTANCE","EXPERT_ASSIST_DELETE_INSTANCE","EXPERT_ASSIST_UPDATE_INSTANCE","EXPERT_ASSIST_INSTANCE_QUEUE_OPERATION","EXPERT_ASSIST_CREATE_INFO_RETRIEVAL_GROUP","EXPERT_ASSIST_UPDATE_INFO_RETRIEVAL_GROUP","EXPERT_ASSIST_DELETE_INFO_RETRIEVAL_GROUP","EXPERT_ASSIST_CREATE_INFO_RETRIEVAL","EXPERT_ASSIST_UPDATE_INFO_RETRIEVAL","EXPERT_ASSIST_DELETE_INFO_RETRIEVAL","EXPERT_ASSIST_CREATE_API","EXPERT_ASSIST_UPDATE_API","EXPERT_ASSIST_DELETE_API","EXPERT_ASSIST_AGENT_CREATE","EXPERT_ASSIST_AGENT_UPDATE","EXPERT_ASSIST_AGENT_DELETE","EXPERT_ASSIST_AGENT_UPDATE_STATUS","EXPERT_ASSIST_AGENT_PUBLISH","EXPERT_ASSIST_AGENT_RESTORE","EXPERT_ASSIST_AGENT_EXPORT","EXPERT_ASSIST_AGENT_IMPORT","EXPERT_ASSIST_AGENT_ASSET_CREATE","EXPERT_ASSIST_AGENT_ASSET_UPDATE","EXPERT_ASSIST_AGENT_ASSET_DELETE","EXPERT_ASSIST_AGENT_ASSET_PUBLISH","EXPERT_ASSIST_SIMULATOR_START","EXPERT_ASSIST_SIMULATOR_SEND_MESSAGE","EXPERT_ASSIST_SIMULATOR_END","CREATE_CUSTOM_AI_AGENT","DELETE_CUSTOM_AI_AGENT","CHANGE_CUSTOM_AI_AGENT","UPDATE_CUSTOM_AI_AGENT","PUBLISH_CUSTOM_AI_AGENT","CREATE_ZVA_AI_AGENT","CHANGE_ZVA_AI_AGENT","DELETE_ZVA_AI_AGENT","PUBLISH_ZVA_AI_AGENT","UPLOAD_VOICE_ACTOR","SAVE_VOICE_ACTOR","DELETE_VOICE_ACTOR","ADD_KB_SEGMENT","UPDATE_KB_SEGMENT","DELETE_KB_SEGMENT","UPDATE_SETTING","DELETE_AGENT_SKILL","ADD_AGENT_SKILL","UPDATE_AGENT_SKILL","CHANGE_SKILL_STATUS","DELETE_AGENT_SKILL_FEW_SHOT","ADD_AGENT_SKILL_FEW_SHOT","UPDATE_AGENT_SKILL_FEW_SHOT","DELETE_AGENT_SKILL_FLOW","ADD_AGENT_SKILL_FLOW","UPDATE_AGENT_SKILL_FlOW","CHANGE_SKILL_FLOW_STATUS","DELETE_AGENT_STARTER_QUESTION","ADD_AGENT_STARTER_QUESTION","UPDATE_AGENT_STARTER_QUESTION","CHANGE_STARTER_QUESTION","UPDATE_SUPPORT_CHANNEL","UPDATE_AGENT","DELETE_AGENT","UPDATE_SUPPORT_CHANNEL_CONFIG","ADD_SUPPORT_CHANNEL_CONFIG","DELETE_SUPPORT_CHANNEL_CONFIG","RESTORE_SUPPORT_CHANNEL_CONFIG","PUBLISH_SUPPORT_CHANNEL_CONFIG","OPTIMIZE_AGENT_GUIDANCE","OPTIMIZE_AGENT_Skill_INSTRUCTION","UPDATE_AI_TOOL","DELETE_AI_TOOL","SYNC_AI_TOOL","CREATE_DICTIONARY","UPDATE_DICTIONARY","DELETE_DICTIONARY","PUBLISH_DICTIONARY","UNPUBLISH_DICTIONARY","ADD_DICTIONARY_TERM","UPDATE_DICTIONARY_TERM","DELETE_DICTIONARY_TERM","IMPORT_DICTIONARY_TERMS","UPLOAD_DICTIONARY_TEST_AUDIO","DELETE_DICTIONARY_TEST_AUDIO","RUN_DICTIONARY_TEST","SUBMIT_ANNOTATION","ADD_AGENT_ASSIST_CATEGORY","UPDATE_AGENT_ASSIST_CATEGORY","UPDATE_AGENT_ASSIST_INFO_RETRIEVAL"]}},{"name":"page_size","in":"query","description":"The number of records to return per page. The default value is 10 and the maximum is 100.","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","nullable":false,"example":10}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token expires after 15 minutes.","required":false,"schema":{"type":"string","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"}}],"responses":{"200":{"description":"Successfully retrieved the operation log page.","content":{"application/json":{"schema":{"type":"object","properties":{"page_size":{"type":"integer","description":"The number of records returned per page.","example":10},"total_records":{"type":"integer","description":"The total number of records.","example":10},"from":{"type":"string","description":"The start date for the query.","example":"2026-01-01"},"to":{"type":"string","description":"The end date for the query.","example":"2026-01-01"},"timezone":{"type":"string","description":"The timezone used for the query.","example":"UTC"},"next_page_token":{"type":"string","description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token expires after 15 minutes.","example":"ngLawmAGlYagy37vLJtKMM4TkMnagfqWm73"},"operation_logs":{"type":"array","description":"The operation history logs.","items":{"type":"object","properties":{"ai_studio_operation_id":{"type":"string","description":"The operation log ID.","example":"log_01HZX8Y3Y8H5M9V3QW7KJY5P9A"},"operator_id":{"type":"string","description":"The `operator_id` corresponds to the `user_id` associated with the user's email address.","example":"u-123456"},"operator_info":{"type":"string","description":"The operator information.","example":"alice@example.com"},"category":{"type":"string","description":"The AI Studio category.","example":"ZVA AI AGENT"},"category_filter_key":{"type":"string","description":"The filter key passed when requesting to filter by category.","example":"ZVA_AI_AGENT"},"action":{"type":"string","description":"The AI Studio action.","example":"Add"},"action_filter_key":{"type":"string","description":"The filter key passed when requesting to filter by action.","example":"ADD"},"subaction":{"type":"string","description":"An optional, human-readable string that provides additional context when the main action is too broad. It has no predefined set of values — each call site defines its own descriptive text, and most audit log entries do not use it.","example":"Create"},"detail":{"type":"string","description":"The log detail information.","example":"Add AI Agent"},"account_id":{"type":"string","description":"The account ID.","example":"a-987654"},"log_time":{"type":"string","description":"The log time.","example":"2026-01-15T08:12:31.123Z"},"op_start_time":{"type":"string","description":"The operation start time.","example":"2026-01-15T08:12:30.987Z"},"op_end_time":{"type":"string","description":"The operation end time.","example":"2026-01-15T08:12:31.123Z"},"create_time":{"type":"string","description":"The action creation time.","example":"2026-01-15T08:12:30.987Z"},"business_id":{"type":"string","description":"The business ID.","example":"agent_8f3c2a"},"business_id_type":{"type":"integer","description":"The business ID type.\n - 1 — ACCOUNT (the business_id refers to an account-level identifier)\n - 2 — AGENT (the business_id refers to an agent-level identifier)","example":1,"enum":[1,2]},"resource_id":{"type":"string","description":"The resource ID, such as an agent ID.","example":"{\\\"aiAgentId\\\":\\\"agent_8f3c2a\\\"}"}},"description":"The operation log object."}}},"description":"The operation log page envelope."}}}},"400":{"description":"**HTTP Status Code:** `400`
\n Bad Request Unable to fetch operation logs.\n\n "},"401":{"description":"**HTTP Status Code:** `401`
\n Unauthorized Missing or invalid authentication.\n\n "},"404":{"description":"**HTTP Status Code:** `404`
\n Not Found API resource does not exist.\n\n "},"429":{"description":"**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zva_report:read","zva_report:read:admin","zva:read:list_operation_logs:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zva_report:read","zva_report:read:admin"],"x-granular-scopes":["zva:read:list_operation_logs:admin"]}}}},"components":{"securitySchemes":{"openapi_authorization":{"type":"apiKey","name":"Authorization","in":"header"},"openapi_oauth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/","tokenUrl":"","refreshUrl":"","scopes":{"zva:write:km_kbs":"zva:write:km_kbs","zva:write:km_article":"zva:write:km_article","zva:write:km_article:admin":"zva:write:km_article:admin","zva:read:km_kbs":"zva:read:km_kbs","zva:read:list_km_articles":"zva:read:list_km_articles","zva:read:list_km_articles:admin":"zva:read:list_km_articles:admin","zva:update:km_article":"zva:update:km_article","zva:update:km_article:admin":"zva:update:km_article:admin","zva:delete:km_article":"zva:delete:km_article","zva:delete:km_article:admin":"zva:delete:km_article:admin","zva:read:km_article":"zva:read:km_article","zva:read:km_article:admin":"zva:read:km_article:admin","zva:update:km_kb:admin":"zva:update:km_kb:admin","zva:read:km_kb:admin":"zva:read:km_kb:admin","zva_report:read":"zva_report:read","zva_report:read:admin":"zva_report:read:admin","zva:read:list_engagements:admin":"zva:read:list_engagements:admin","zva:read:list_queries:admin":"zva:read:list_queries:admin","zva:read:list_variables:admin":"zva:read:list_variables:admin","zva:read:list_surveys:admin":"zva:read:list_surveys:admin","zva:read:list_transcripts:admin":"zva:read:list_transcripts:admin","zva:read:list_operation_logs:admin":"zva:read:list_operation_logs:admin"}}}}}}}