{"openapi":"3.0.0","info":{"title":"AI Companion","description":"Note: The AI Companion brand has been retired. AI-powered features are now more deeply integrated throughout Zoom Workplace. Existing APIs and SDKs that reference AI Companion will continue to function as before to ensure backward compatibility.\n\nZoom AI Companion APIs let you manage user interactions with Zoom AI, no matter which service the panel was opened in. They also support archiving prompts and responses.","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":{"/aic/users/{userId}/conversation_archive":{"get":{"tags":["Archived"],"summary":"Get AI Companion conversation archives","description":"Retrieve the AI Companion conversation archives.\n\nNote: The AI Companion brand has been retired. AI-powered features are now more deeply integrated throughout Zoom Workplace. Existing APIs and SDKs that reference AI Companion will continue to function as before to ensure backward compatibility.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aic_archive:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `aic:read:conversation_archives:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"GetAICconversationarchives","parameters":[{"name":"userId","in":"path","description":"The user's user ID.","required":true,"schema":{"type":"string","example":"ABCDEF123456"}},{"name":"from","in":"query","description":"The archive query start time. Use RFC 3339 timestamp format with timezone, for example `2026-05-18T00:00:00Z`. If `from` is provided and `to` is omitted, the API uses the current time as the end time. The time range must not exceed 90 days.","required":false,"schema":{"type":"string","format":"date-time","example":"2026-05-18T00:00:00Z"}},{"name":"to","in":"query","description":"The archive query end time. Use RFC 3339 timestamp format with timezone, for example `2026-05-18T23:59:59Z`. If omitted while `from` is provided, the API uses the current time as the end time. The time range must not exceed 90 days.","required":false,"schema":{"type":"string","format":"date-time","example":"2026-05-18T23:59:59Z"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nAI Companion conversation archive returned.","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string","description":"User ID.","example":"ABCDEF123456"},"email":{"type":"string","description":"The user's email address.","example":"jchill@example.com"},"display_name":{"type":"string","description":"The user's display name.","example":"Jill Chill"},"start_time":{"type":"string","description":"The AI Companion conversation history start time.","example":"2021-04-26T05:23:18Z"},"end_time":{"type":"string","description":"The AI Companion conversation history end time.","example":"2021-05-26T05:23:18Z"},"timezone":{"type":"string","description":"The AI Companion conversation history timezone.","example":"Asia/Shanghai"},"aic_history_download_url":{"type":"string","description":"The URL to download the the AI Companion conversion history file. \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains account user scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the AIC conversation history file for the user. For example, `https://{{base-domain}}/rest/v1/aic/archive/conversations/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`.","example":"https://aic.zoom.us/rest/v1/aic/archive/conversations/download/Qg75t7xZBtEbAkjdlgbfdngBBBB"},"file_extension":{"type":"string","description":"The AI Companion data file's extension.","example":"JSON","enum":["JSON"]},"file_size":{"type":"integer","description":"The AI Companion data file's size, in bytes.","example":165743},"file_type":{"type":"string","description":"The AI Companion data file's type. \n* `AIC_CONVERSATION` - AI Companion Conversation file.","example":"AIC_CONVERSATION","enum":["AIC_CONVERSATION"]},"physical_files":{"maxItems":300,"minItems":0,"type":"array","description":"Information about the AI Companion physical query data files.","items":{"type":"object","properties":{"file_id":{"type":"string","description":"The AI Companion physical query data file's unique ID.","example":"pvKocCqVSMygaOcKus5Afw"},"file_name":{"type":"string","description":"The AI Companion physical query data file's name.","example":"Screenshot 2025-02-12 at 10.42.27 AM.png"},"file_size":{"type":"integer","description":"The AI Companion physical query data file's size, in bytes.","example":540680},"download_url":{"type":"string","description":"The URL to download the AI Companion physical query data file. \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains account user scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file. \n\n Example: \n\n `https://{{base-domain}}/rest/v1/aic/archive/attached/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`.","example":"https://aic.zoom.us/rest/v1/aic/archive/attached/download/HBAXbHc15BXbnq0JoDu6tc5MWlww9MAo9JJq2d14VAWkpcT5FEA.AK5calud4EJB7bMq"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid time range. \n\n **Error Code:** `20525` <br>\n Returned when `from` or `to` is not a valid RFC 3339 timestamp. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authentication required to access this resource. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `20514` <br>\n User does not have permission to access this resource. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `20524` <br>\n User does not exist: {userId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["aic_archive:read:admin","aic:read:conversation_archives:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["User:Read"],"x-macro-scopes":["aic_archive:read:admin"],"x-granular-scopes":["aic:read:conversation_archives:admin"]}}}},"components":{"securitySchemes":{"openapi_authorization":{"type":"apiKey","name":"Authorization","in":"header"},"openapi_oauth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/","tokenUrl":"","refreshUrl":"","scopes":{"aic_archive:read:admin":"aic_archive:read:admin","aic:read:conversation_archives:admin":"aic:read:conversation_archives:admin"}}}}}}}