{
"success": false,
"message": "Conversation logs service not available"
}
Conversation Logs
Query conversation logs
Returns authorized conversation logs for a time range. Select returned fields, export CSV, or filter any log field with query names such as duration__gte, eventType__in, or metadata.status__icontains. Supported suffixes are eq, ne, gt, gte, lt, lte, in, nin, contains, icontains, startswith, istartswith, endswith, iendswith, regex, iregex, isnull, isset, empty, notempty, and present. Without a suffix, a field uses exact matching.
GET
/
api
/
v2
/
logs
Query conversation logs
curl --request GET \
--url 'https://api.vida.dev/api/v2/logs?token='
Replace field with a log field name and suffix with a supported comparison. Values may use an explicit ||json, ||bool, ||number, ||null, or ||string type hint. Repeat this pattern for each filter.
Response
Successful JSON response. When format=csv, a CSV file is streamed with status 200.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Vida AI Agent OS Docs","colors":{"primary":"#0075FF","light":"#0075FF","dark":"#0075FF"},"logo":{"light":"https://mintcdn.com/vida/MUI7MaE2JUvHNPoO/logos/blank.svg?fit=max\u0026auto=format\u0026n=MUI7MaE2JUvHNPoO\u0026q=85\u0026s=3388b7be4b5e339589764386f1b37423","dark":"https://mintcdn.com/vida/MUI7MaE2JUvHNPoO/logos/blank.svg?fit=max\u0026auto=format\u0026n=MUI7MaE2JUvHNPoO\u0026q=85\u0026s=3388b7be4b5e339589764386f1b37423","href":"https://vida.io"},"favicon":"https://mintcdn.com/vida/hvah8j310xMyIxzD/logos/favicon.png?fit=max\u0026auto=format\u0026n=hvah8j310xMyIxzD\u0026q=85\u0026s=d6747aa04480ffe1e7c6e6573060bb02","api":{"openapi":["apiv2.json"]},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://vida.io/docs/apiv2.json","label":"OpenAPI Definition"},{"href":"https://vida.io/examples","label":"Examples"},{"href":"https://vida.io/pricing","label":"Pricing"}],"primary":{"type":"button","label":"Login","href":"https://vida.io/?login=true"}},"footer":{"socials":{"x":"https://x.com/VIDAisAI","github":"https://github.com/VIDA-Global","linkedin":"https://www.linkedin.com/company/86956543"}},"seo":{"metatags":{"description":"Build, deploy, operate, and integrate Vida AI Agents across business communications and operations.","og:title":"Vida AI Agent OS Documentation","og:description":"Build, deploy, operate, and integrate Vida AI Agents across voice, text, email, chat, software, and business workflows.","og:image":"https://vida.io/images/openGraphImage-noBrand.png","og:image:width":"3600","og:image:height":"1881","og:site_name":"Vida AI Agent OS Documentation","twitter:title":"Vida AI Agent OS Documentation","twitter:description":"Build, deploy, operate, and integrate Vida AI Agents across business communications and operations.","twitter:image":"https://vida.io/images/openGraphImage-noBrand.png","twitter:site:":"@VIDAisAI","twitter:creator":"@VIDAisAI","twitter:card":"summary_large_image"},"indexing":"navigable"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vida","hasAudioNarration":false,"actualSubdomain":"vida","customDomains":["vida.io","vida.page"],"gitSource":{"type":"github","owner":"vida-global","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af23ebeb92fa174c66bb205","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":273},{"language":"default","tag":"Documentation","count":89},{"language":"default","tag":"Computer Agents","count":89},{"language":"default","tag":"Agents","count":24},{"language":"default","tag":"Accounts","count":21},{"language":"default","tag":"Agent Functions","count":20},{"language":"default","tag":"Tasks","count":17},{"language":"default","tag":"Resellers and Partners","count":16},{"language":"default","tag":"Agent Setup","count":14},{"language":"default","tag":"SIP","count":14}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html[data-domain] img[alt=\"light logo\"],html[data-domain] img[alt=\"dark logo\"]{visibility:hidden}"}],"page":{"pagePath":"api-reference/conversation-logs/query-conversation-logs","slug":"/api-reference/conversation-logs/query-conversation-logs","pageMetadata":{"openapi":"get /api/v2/logs","title":"Query conversation logs","description":"Returns authorized conversation logs for a time range. Select returned fields, export CSV, or filter any log field with query names such as duration__gte, eventType__in, or metadata.status__icontains. Supported suffixes are eq, ne, gt, gte, lt, lte, in, nin, contains, icontains, startswith, istartswith, endswith, iendswith, regex, iregex, isnull, isset, empty, notempty, and present. Without a suffix, a field uses exact matching.","href":"/api-reference/conversation-logs/query-conversation-logs"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns authorized conversation logs for a time range. Select returned fields, export CSV, or filter any log field with query names such as duration__gte, eventType__in, or metadata.status__icontains. Supported suffixes are eq, ne, gt, gte, lt, lte, in, nin, contains, icontains, startswith, istartswith, endswith, iendswith, regex, iregex, isnull, isset, empty, notempty, and present. Without a suffix, a field uses exact matching.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /api/v2/logs","title":"Query conversation logs","description":"Returns authorized conversation logs for a time range. Select returned fields, export CSV, or filter any log field with query names such as duration__gte, eventType__in, or metadata.status__icontains. Supported suffixes are eq, ne, gt, gte, lt, lte, in, nin, contains, icontains, startswith, istartswith, endswith, iendswith, regex, iregex, isnull, isset, empty, notempty, and present. Without a suffix, a field uses exact matching.","href":"/api-reference/conversation-logs/query-conversation-logs"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/vida/121b9aa6cf00f9e5/script.js","/docs/_mintlify/custom/vida/a6ea228b56014007/updateMintlifyDocs.js"],"openApiReferenceData":{"operation":{"tags":["Conversation Logs"],"summary":"Query conversation logs","description":"Returns authorized conversation logs for a time range. Select returned fields, export CSV, or filter any log field with query names such as duration__gte, eventType__in, or metadata.status__icontains. Supported suffixes are eq, ne, gt, gte, lt, lte, in, nin, contains, icontains, startswith, istartswith, endswith, iendswith, regex, iregex, isnull, isset, empty, notempty, and present. Without a suffix, a field uses exact matching.","parameters":["3b36d21d-9a5e-4929-8386-951f4e2c0eae","062832c2-2d12-41c4-8dd2-169fbd7d2eae","91bf4349-b888-4a4e-b449-e8d99b9d42ff","7b58feb5-78e9-4cba-8828-313b3c85e069","4fb48670-5278-428a-b563-9c158a344616","cd507c19-13e6-4325-b6f6-7451cb7f0c30","923cec8a-a2a9-47b1-a5dc-281a604753e4","1f69047e-21f2-4728-aad2-cd08b659dd78","6c9d59c1-e1d0-473a-b621-0e914fe632e3","53eec06c-b061-4c46-b0ae-d0221718bae8"],"responses":{"200":"5607be88-04bc-4886-8cc8-1988709154f0","401":"eb7ef11d-651e-4570-8144-6d332ee7512b","404":"5efe5492-77bc-478f-976d-b9502efb2050","500":"93805f56-bbb1-4e9e-aff5-340ef8b1a859","503":"4568f425-584e-4aad-985c-11a216766831"},"security":["9a1016f0-9668-453d-8903-186853556bc1"],"method":"get","type":"path","servers":["0413c5fa-3167-42c0-a5fc-9c7b1412aaa5"],"path":"/api/v2/logs","baseUrlOptions":["https://api.vida.dev"],"title":"Query conversation logs","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3b36d21d-9a5e-4929-8386-951f4e2c0eae":{"name":"start","in":"query","required":false,"description":"Start time as Unix seconds. Defaults to Unix epoch (Jan 1 1970 00:00:00 UTC).","example":1727481600,"schema":{"type":"integer","isRequired":false,"description":"Start time as Unix seconds. Defaults to Unix epoch (Jan 1 1970 00:00:00 UTC).","uniqueKey":"","typeLabel":"integer"}},"062832c2-2d12-41c4-8dd2-169fbd7d2eae":{"name":"end","in":"query","required":false,"description":"End time as Unix seconds. Defaults to current time.","example":1728086400,"schema":{"type":"integer","isRequired":false,"description":"End time as Unix seconds. Defaults to current time.","uniqueKey":"","typeLabel":"integer"}},"91bf4349-b888-4a4e-b449-e8d99b9d42ff":{"name":"fields","in":"query","required":false,"description":"Comma separated list of fields to include. Restricted fields are always removed.","example":"id,timestamp,account_id,org_id,eventType","schema":{"type":"string","isRequired":false,"description":"Comma separated list of fields to include. Restricted fields are always removed.","uniqueKey":"","typeLabel":"string"}},"7b58feb5-78e9-4cba-8828-313b3c85e069":{"name":"format","in":"query","required":false,"description":"Response format. json returns a JSON envelope. csv streams a CSV file.","schema":{"type":"string","enum":["json","csv"],"default":"json","isRequired":false,"description":"Response format. json returns a JSON envelope. csv streams a CSV file.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"4fb48670-5278-428a-b563-9c158a344616":{"name":"pageSize","in":"query","required":false,"description":"Page size for pagination. Max 10000. Defaults to 20.","example":500,"schema":{"type":"integer","minimum":1,"maximum":10000,"isRequired":false,"description":"Page size for pagination. Max 10000. Defaults to 20.","uniqueKey":"","typeLabel":"integer"}},"cd507c19-13e6-4325-b6f6-7451cb7f0c30":{"name":"page","in":"query","required":false,"description":"Page number starting at 1. Defaults to 1.","example":1,"schema":{"type":"integer","minimum":1,"isRequired":false,"description":"Page number starting at 1. Defaults to 1.","uniqueKey":"","typeLabel":"integer"}},"923cec8a-a2a9-47b1-a5dc-281a604753e4":{"name":"includeFields","in":"query","required":false,"description":"When truthy, include an inferred schema array in the JSON response.","example":true,"schema":{"type":"boolean","isRequired":false,"description":"When truthy, include an inferred schema array in the JSON response.","uniqueKey":"","typeLabel":"boolean"}},"1f69047e-21f2-4728-aad2-cd08b659dd78":{"name":"targetAccountId","in":"query","required":false,"description":"Selected account whose conversation logs should be returned. Include this when the API token can access more than one account.","example":3026480,"schema":{"type":"integer","isRequired":false,"description":"Selected account whose conversation logs should be returned. Include this when the API token can access more than one account.","uniqueKey":"","typeLabel":"integer"}},"6c9d59c1-e1d0-473a-b621-0e914fe632e3":{"name":"outcome","in":"query","required":false,"description":"Match fields against one task-goal evaluation in the log outcomes array. Supply a URL-encoded JSON object followed by ||json.","example":"%7B%22type%22%3A%22task_goal%22%2C%22status%22%3A%22evaluated%22%2C%22value%22%3Atrue%7D%7C%7Cjson","schema":{"type":"string","isRequired":false,"description":"Match fields against one task-goal evaluation in the log outcomes array. Supply a URL-encoded JSON object followed by ||json.","uniqueKey":"","typeLabel":"string"}},"53eec06c-b061-4c46-b0ae-d0221718bae8":{"name":"field__suffix","in":"query","required":false,"description":"Replace field with a log field name and suffix with a supported comparison. Values may use an explicit ||json, ||bool, ||number, ||null, or ||string type hint. Repeat this pattern for each filter.","example":"120||number","schema":{"type":"string","isRequired":false,"description":"Replace field with a log field name and suffix with a supported comparison. Values may use an explicit ||json, ||bool, ||number, ||null, or ||string type hint. Repeat this pattern for each filter.","uniqueKey":"","typeLabel":"string"}}},"responses":{"5607be88-04bc-4886-8cc8-1988709154f0":{"description":"Successful JSON response. When format=csv, a CSV file is streamed with status 200.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"Success","uniqueKey":"message","typeLabel":"string"},"logs":{"type":"array","description":"Array of log entries with restricted fields removed based on caller scope.","items":{"type":"object","additionalProperties":true,"example":{"id":"log_001","timestamp":"2025-09-30T12:34:56.789Z","account_id":"acct_123","org_id":"org_456","eventType":"message.created","metadata":{"convoId":"c_abc","tokens":1234},"outcomes":[{"type":"task_goal","status":"evaluated","value":true,"source":"task_goal_evaluator","schemaVersion":1}]},"uniqueKey":"logs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"logs","typeLabel":"object[]"},"count":{"type":"integer","example":20,"uniqueKey":"count","typeLabel":"integer"},"totalCount":{"type":"integer","example":5231,"uniqueKey":"totalCount","typeLabel":"integer"},"pagination":{"type":"object","properties":{"page":{"type":"integer","example":1,"uniqueKey":"pagination.page","typeLabel":"integer"},"pageSize":{"type":"integer","example":20,"uniqueKey":"pagination.pageSize","typeLabel":"integer"},"totalPages":{"type":"integer","example":262,"uniqueKey":"pagination.totalPages","typeLabel":"integer"},"totalCount":{"type":"integer","example":5231,"uniqueKey":"pagination.totalCount","typeLabel":"integer"},"hasMore":{"type":"boolean","example":true,"uniqueKey":"pagination.hasMore","typeLabel":"boolean"},"pageCount":{"type":"integer","example":262,"uniqueKey":"pagination.pageCount","typeLabel":"integer"}},"uniqueKey":"pagination","typeLabel":"object"},"schema":{"type":"array","description":"Returned only when includeFields is truthy. The inferred list of available fields.","items":{"type":"string","uniqueKey":"schema.items.[INDEX]","typeLabel":"string"},"example":["id","timestamp","account_id","org_id","eventType","metadata"],"uniqueKey":"schema","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"Success","logs":[{"id":"log_001","timestamp":"2025-09-30T12:34:56.789Z","account_id":"acct_123","org_id":"org_456","eventType":"message.created","metadata":{"convoId":"c_abc","tokens":1234},"outcomes":[{"type":"task_goal","status":"evaluated","value":true,"source":"task_goal_evaluator","schemaVersion":1}]}],"count":20,"totalCount":5231,"pagination":{"page":1,"pageSize":20,"totalPages":262,"totalCount":5231,"hasMore":true,"pageCount":262},"schema":["id","timestamp","account_id","org_id","eventType","metadata"]}}},"exampleType":"generated"},"text/csv":{"schema":{"type":"string","format":"binary","description":"CSV export of logs when format=csv","uniqueKey":"","typeLabel":"file"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"}},"exampleType":"generated"},"eb7ef11d-651e-4570-8144-6d332ee7512b":{"description":"Unauthorized. req.user missing or invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"Unauthorized Request","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Unauthorized Request"}}},"exampleType":"generated"}},"exampleType":"generated"},"5efe5492-77bc-478f-976d-b9502efb2050":{"description":"No logs available for CSV export when format=csv","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"No logs found for CSV export","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"No logs found for CSV export"}}},"exampleType":"generated"}},"exampleType":"generated"},"93805f56-bbb1-4e9e-aff5-340ef8b1a859":{"description":"Unhandled server error while fetching logs or generating CSV","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"An error occurred while fetching conversation logs.","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","example":"Detailed error message","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"An error occurred while fetching conversation logs.","error":"Detailed error message"}}},"exampleType":"generated"}},"exampleType":"generated"},"4568f425-584e-4aad-985c-11a216766831":{"description":"Conversation logs service not available","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"Conversation logs service not available","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Conversation logs service not available"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9a1016f0-9668-453d-8903-186853556bc1":{"apiKeyAuth":{"type":"apiKey","in":"query","name":"token","description":"Vida API Token","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"0413c5fa-3167-42c0-a5fc-9c7b1412aaa5":{"url":"https://api.vida.dev","description":"Vida Production","variables":{"baseUrl":{"default":"api.vida.dev","description":"Production API Root"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"query","name":"token","description":"Vida API Token","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"token","type":"string","description":"Vida API Token","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"token"}],"title":"apiKeyAuth"}]},"originalFileLocation":"apiv2.json"},"subdomain":"vida","siteName":"Vida AI Agent OS Docs","title":"Vida AI Agent OS Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-21T02:25:24.411Z","originalFileLocation":"api-reference/conversation-logs/query-conversation-logs.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns authorized conversation logs for a time range. Select returned fields, export CSV, or filter any log field with query names such as durationgte, eventTypein, or metadata.status__icontains. Supported suffixes are eq, ne, gt, gte, lt, lte, in, nin, contains, icontains, startswith, istartswith, endswith, iendswith, regex, iregex, isnull, isset, empty, notempty, and present. Without a suffix, a field uses exact matching.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vida AI Agent OS Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/vida/NyE2MrsaQNcyncaE/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/vida/NyE2MrsaQNcyncaE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/vida/NyE2MrsaQNcyncaE/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/vida/NyE2MrsaQNcyncaE/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/vida/NyE2MrsaQNcyncaE/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/vida/NyE2MrsaQNcyncaE/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/vida/NyE2MrsaQNcyncaE/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/vida/NyE2MrsaQNcyncaE/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/vida/NyE2MrsaQNcyncaE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Vida AI Agent OS Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Build, deploy, operate, and integrate Vida AI Agents across voice, text, email, chat, software, and business workflows.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vida AI Agent OS Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://vida.io/docs/api-reference/conversation-logs/query-conversation-logs\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vida.io/images/openGraphImage-noBrand.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Vida AI Agent OS Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Build, deploy, operate, and integrate Vida AI Agents across business communications and operations.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vida.io/images/openGraphImage-noBrand.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/vida/NyE2MrsaQNcyncaE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vida AI Agent OS Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0075FF\">\u003cmeta data-mint-head name=\"twitter:site:\" content=\"@VIDAisAI\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@VIDAisAI\">\u003clink data-mint-head rel=\"canonical\" href=\"https://vida.io/docs/api-reference/conversation-logs/query-conversation-logs\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/conversation-logs/query-conversation-logs.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://vida.io/#organization\",\"name\":\"Vida AI Agent OS Docs\",\"url\":\"https://vida.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vida/MUI7MaE2JUvHNPoO/logos/blank.svg?fit=max\u0026auto=format\u0026n=MUI7MaE2JUvHNPoO\u0026q=85\u0026s=3388b7be4b5e339589764386f1b37423\"}},{\"@type\":\"WebSite\",\"@id\":\"https://vida.io/docs#website\",\"name\":\"Vida AI Agent OS Docs\",\"url\":\"https://vida.io/docs\",\"publisher\":{\"@id\":\"https://vida.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://vida.io/docs/api-reference/conversation-logs/query-conversation-logs#webpage\",\"url\":\"https://vida.io/docs/api-reference/conversation-logs/query-conversation-logs\",\"name\":\"Query conversation logs\",\"description\":\"Returns authorized conversation logs for a time range. Select returned fields, export CSV, or filter any log field with query names such as durationgte, eventTypein, or metadata.status__icontains. Supported suffixes are eq, ne, gt, gte, lt, lte, in, nin, contains, icontains, startswith, istartswith, endswith, iendswith, regex, iregex, isnull, isset, empty, notempty, and present. Without a suffix, a field uses exact matching.\",\"dateModified\":\"2026-08-21T02:25:24.411Z\",\"isPartOf\":{\"@id\":\"https://vida.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://vida.io/docs/api-reference/conversation-logs/query-conversation-logs#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://vida.io/docs/api-reference/conversation-logs/query-conversation-logs#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Vida AI Agent OS Docs\",\"item\":\"https://vida.io/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Query conversation logs\",\"item\":\"https://vida.io/docs/api-reference/conversation-logs/query-conversation-logs\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://vida.io/docs/api-reference/conversation-logs/query-conversation-logs#apireference\",\"headline\":\"Query conversation logs\",\"name\":\"Query conversation logs\",\"description\":\"Returns authorized conversation logs for a time range. Select returned fields, export CSV, or filter any log field with query names such as durationgte, eventTypein, or metadata.status__icontains. Supported suffixes are eq, ne, gt, gte, lt, lte, in, nin, contains, icontains, startswith, istartswith, endswith, iendswith, regex, iregex, isnull, isset, empty, notempty, and present. Without a suffix, a field uses exact matching.\",\"url\":\"https://vida.io/docs/api-reference/conversation-logs/query-conversation-logs\",\"mainEntityOfPage\":{\"@id\":\"https://vida.io/docs/api-reference/conversation-logs/query-conversation-logs#webpage\"},\"image\":\"https://vida.io/images/openGraphImage-noBrand.png\",\"dateModified\":\"2026-08-21T02:25:24.411Z\",\"publisher\":{\"@id\":\"https://vida.io/#organization\"},\"isPartOf\":{\"@id\":\"https://vida.io/docs#website\"}}]}\u003c/script>","siteName":"Vida AI Agent OS Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/welcome"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Vida API overview","href":"/api-reference/overview"},{"title":"Getting started","href":"/api-reference/getting-started"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Vida API Skill","href":"/api-reference/vida-api-skill"}]},{"group":"Agent API Guides","pages":[{"title":"Configure Agents through the API","href":"/api-reference/agent-guides/overview"},{"title":"Configuration lifecycle","href":"/api-reference/agent-guides/configuration-lifecycle"},{"title":"Versions and experiments","href":"/api-reference/agent-guides/versions-and-experiments"},{"title":"Models and reasoning","href":"/api-reference/agent-guides/models-and-reasoning"},{"title":"Language, voice, and speech","href":"/api-reference/agent-guides/language-voice-and-speech"},{"title":"Agent functions","href":"/api-reference/agent-guides/functions"},{"title":"Agent apps","href":"/api-reference/agent-guides/apps"},{"title":"Phone numbers and SIP","href":"/api-reference/agent-guides/telephony"},{"title":"Computer Agent configuration","href":"/api-reference/agent-guides/computer-agents"},{"title":"Computer Agent lifecycle and support","href":"/api-reference/agent-guides/computer-agent-operations"},{"title":"Computer Agent skills, credentials, and channels","href":"/api-reference/agent-guides/computer-agent-skills-and-channels"},{"title":"Workspaces, helpers, and browser automation","href":"/api-reference/agent-guides/computer-agent-workspaces-and-helpers"},{"title":"Computer Agent Canvas","href":"/api-reference/agent-guides/computer-agent-canvas"}]},{"group":"Platform API Guides","pages":[{"title":"Tasks and automation","href":"/api-reference/platform-guides/tasks-and-automation"},{"title":"Contacts and ongoing objectives","href":"/api-reference/platform-guides/contacts-and-objectives"},{"title":"Logs, conversations, and reporting","href":"/api-reference/platform-guides/logs-conversations-and-reporting"},{"title":"Accounts, access, and customer onboarding","href":"/api-reference/platform-guides/accounts-access-and-onboarding"},{"title":"Connect Stripe or Chargebee billing","href":"/api-reference/platform-guides/billing-providers"},{"title":"Reseller Agent templates","href":"/api-reference/platform-guides/agent-templates"},{"title":"Integrations, inbound email, and webhooks","href":"/api-reference/platform-guides/integrations-email-and-webhooks"},{"title":"White-label domains and embedded access","href":"/api-reference/platform-guides/white-label-domains-and-embed"}]},{"group":"Authorization","pages":[{"openapi":"get /api/v2/tokens","title":"List tokens","href":"/api-reference/authorization/list-tokens"},{"openapi":"post /api/v2/tokens","title":"Create a token","href":"/api-reference/authorization/create-a-token"},{"openapi":"delete /api/v2/tokens","title":"Delete a token","href":"/api-reference/authorization/delete-a-token"},{"openapi":"get /api/v2/auth/account/oneTimeAuthToken","title":"Generate one-time auth token","href":"/api-reference/authorization/generate-one-time-auth-token"}]},{"group":"Agents","pages":[{"openapi":"get /api/v2/agent/functions","title":"List agent functions","href":"/api-reference/agents/list-agent-functions"},{"openapi":"get /api/v2/agent/voices","title":"List agent voices","href":"/api-reference/agents/list-agent-voices"},{"openapi":"post /api/v2/agent/publish","title":"Publish an Agent","href":"/api-reference/agents/publish-an-agent"},{"openapi":"post /api/v2/agent/revert","title":"Revert an Agent","href":"/api-reference/agents/revert-an-agent"},{"openapi":"post /api/v2/agent","title":"Update staging agent configuration","href":"/api-reference/agents/update-staging-agent-configuration"},{"openapi":"get /api/v2/agent/{agentConfigId}/versions","title":"List Agent Versions","href":"/api-reference/agents/list-agent-versions"},{"openapi":"post /api/v2/agent/{agentConfigId}/versions","title":"Save agent version","href":"/api-reference/agents/save-agent-version"},{"openapi":"post /api/v2/agent/{agentConfigId}/versions/{versionId}","title":"Replace saved agent version","href":"/api-reference/agents/replace-saved-agent-version"},{"openapi":"delete /api/v2/agent/{agentConfigId}/versions/{versionId}","title":"Delete saved agent version","href":"/api-reference/agents/delete-saved-agent-version"},{"openapi":"post /api/v2/agent/{agentConfigId}/versions/{versionId}/restore","title":"Restore saved agent version","href":"/api-reference/agents/restore-saved-agent-version"},{"openapi":"put /api/v2/agent/{agentConfigId}/versions/{versionId}/title","title":"Rename saved agent version","href":"/api-reference/agents/rename-saved-agent-version"},{"openapi":"get /api/v2/agent/{agentConfigId}","title":"Get Agent","href":"/api-reference/agents/get-agent"},{"openapi":"post /api/v2/agent/outboundCall","title":"Queue outbound call(s) from your Agent","href":"/api-reference/agents/queue-outbound-calls-from-your-agent"},{"openapi":"post /api/v2/agent/outboundSms","title":"Queue outbound SMS text message(s) from your Agent","href":"/api-reference/agents/queue-outbound-sms-text-messages-from-your-agent"},{"openapi":"post /api/v2/agent/outboundEmail","title":"Queue outbound email(s) from your Agent","href":"/api-reference/agents/queue-outbound-emails-from-your-agent"},{"openapi":"get /api/v2/agentEventRules/staging","title":"Fetch Staging Agent","href":"/api-reference/agents/fetch-staging-agent"},{"openapi":"get /api/v2/agentEventRules/default","title":"Fetch Live Agent","href":"/api-reference/agents/fetch-live-agent"},{"openapi":"post /api/v2/agent/autoReviewAgentConfiguration","title":"Review an Agent configuration","href":"/api-reference/agents/review-an-agent-configuration"},{"openapi":"get /api/v2/experiments","title":"List agent experiments","href":"/api-reference/agents/list-agent-experiments"},{"openapi":"post /api/v2/experiments","title":"Create agent experiment","href":"/api-reference/agents/create-agent-experiment"},{"openapi":"get /api/v2/experiments/{experimentId}","title":"Get agent experiment","href":"/api-reference/agents/get-agent-experiment"},{"openapi":"put /api/v2/experiments/{experimentId}","title":"Update agent experiment","href":"/api-reference/agents/update-agent-experiment"},{"openapi":"delete /api/v2/experiments/{experimentId}","title":"Delete agent experiment","href":"/api-reference/agents/delete-agent-experiment"},{"openapi":"post /api/v2/experiments/{experimentId}/status","title":"Change agent experiment status","href":"/api-reference/agents/change-agent-experiment-status"}]},{"group":"Phone Numbers","pages":[{"openapi":"get /api/v2/phoneNumbers","title":"List assigned phone numbers","href":"/api-reference/phone-numbers/list-assigned-phone-numbers"},{"openapi":"post /api/v2/phoneNumber/assign","title":"Assign phone number to your account","href":"/api-reference/phone-numbers/assign-phone-number-to-your-account"},{"openapi":"post /api/v2/phoneNumber/byo/assign","title":"Assign a BYO phone number","href":"/api-reference/phone-numbers/assign-a-byo-phone-number"},{"openapi":"post /api/v2/phoneNumber/return","title":"Return / Unassign Phone Number","href":"/api-reference/phone-numbers/return-unassign-phone-number"},{"openapi":"post /api/v2/phoneNumber/search/local/locality","title":"Search for local numbers by locality","href":"/api-reference/phone-numbers/search-for-local-numbers-by-locality"},{"openapi":"post /api/v2/phoneNumber/search/local/prefix","title":"Search for local numbers by prefix","href":"/api-reference/phone-numbers/search-for-local-numbers-by-prefix"},{"openapi":"post /api/v2/phoneNumber/search/local/phrase","title":"Search for local numbers by phrase","href":"/api-reference/phone-numbers/search-for-local-numbers-by-phrase"},{"openapi":"get /api/v2/numberingProviders","title":"List supported numbering providers","href":"/api-reference/phone-numbers/list-supported-numbering-providers"},{"openapi":"put /api/v2/numberingProvider","title":"Update an existing numbering provider","href":"/api-reference/phone-numbers/update-an-existing-numbering-provider"},{"openapi":"post /api/v2/numberingProvider","title":"Add a numbering provider to an organization","href":"/api-reference/phone-numbers/add-a-numbering-provider-to-an-organization"}]},{"group":"SIP","pages":[{"openapi":"get /api/v2/sip/captures","title":"Fetch SIP Captures by SIP Call-ID","href":"/api-reference/sip/fetch-sip-captures-by-sip-call-id"},{"openapi":"get /api/v2/sip/ipWhitelist","title":"List SIP IP Whitelist","href":"/api-reference/sip/list-sip-ip-whitelist"},{"openapi":"post /api/v2/sip/ipWhitelist","title":"Add IP to SIP IP Whitelist","href":"/api-reference/sip/add-ip-to-sip-ip-whitelist"},{"openapi":"delete /api/v2/sip/ipWhitelist","title":"Remove IP from SIP IP Whitelist","href":"/api-reference/sip/remove-ip-from-sip-ip-whitelist"},{"openapi":"get /api/v2/sip/outboundRoutes","title":"List SIP Outbound Routes","href":"/api-reference/sip/list-sip-outbound-routes"},{"openapi":"post /api/v2/sip/outboundRoutes","title":"Add SIP Outbound Route","href":"/api-reference/sip/add-sip-outbound-route"},{"openapi":"delete /api/v2/sip/outboundRoutes","title":"Remove SIP Outbound Route","href":"/api-reference/sip/remove-sip-outbound-route"},{"openapi":"post /api/v2/sip/registration/available","title":"Check SIP registration AOR availability","href":"/api-reference/sip/check-sip-registration-aor-availability"},{"openapi":"get /api/v2/sip/registration","title":"Get SIP registration","href":"/api-reference/sip/get-sip-registration"},{"openapi":"post /api/v2/sip/registration","title":"Create or update SIP registration","href":"/api-reference/sip/create-or-update-sip-registration"},{"openapi":"delete /api/v2/sip/registration","title":"Delete SIP registration","href":"/api-reference/sip/delete-sip-registration"}]},{"group":"Messaging","pages":[{"openapi":"get /api/v2/conversations","title":"List Priority Inbox","href":"/api-reference/messaging/list-priority-inbox"},{"openapi":"get /api/v2/junkConversations","title":"List Junk Inbox","href":"/api-reference/messaging/list-junk-inbox"},{"openapi":"get /api/v2/messages/recent","title":"Fetch Recent Messages","href":"/api-reference/messaging/fetch-recent-messages"},{"openapi":"get /api/v2/messages/{roomId}","title":"Fetch Room Messages","href":"/api-reference/messaging/fetch-room-messages"},{"openapi":"post /api/v2/agent/receiveMessage","title":"Send message to an agent from your own platform","href":"/api-reference/messaging/send-message-to-an-agent-from-your-own-platform"}]},{"group":"Webhooks","pages":[{"openapi":"get /api/v2/webhooks","title":"List Webhooks","href":"/api-reference/webhooks/list-webhooks"},{"openapi":"post /api/v2/webhooks","title":"Add Webhook","href":"/api-reference/webhooks/add-webhook"},{"openapi":"delete /api/v2/webhooks","title":"Remove Webhook","href":"/api-reference/webhooks/remove-webhook"},{"openapi":"get /api/v2/webhookRelay/types","title":"List supported Webhook Relay types","href":"/api-reference/webhooks/list-supported-webhook-relay-types"},{"openapi":"get /api/v2/webhookRelay/{type}","title":"Get a webhook relay configuration","href":"/api-reference/webhooks/get-a-webhook-relay-configuration"},{"openapi":"post /api/v2/webhookRelay/{type}","title":"Create or update a webhook relay","href":"/api-reference/webhooks/create-or-update-a-webhook-relay"},{"openapi":"delete /api/v2/webhookRelay/{type}","title":"Delete a webhook relay configuration","href":"/api-reference/webhooks/delete-a-webhook-relay-configuration"},{"openapi":"get /api/v2/webhookRelay","title":"List all webhook relay configurations","href":"/api-reference/webhooks/list-all-webhook-relay-configurations"}]},{"group":"Knowledge","pages":[{"openapi":"get /api/v2/context","title":"Fetch Context","href":"/api-reference/knowledge/fetch-context"},{"openapi":"post /api/v2/context","title":"Add Context","href":"/api-reference/knowledge/add-context"}]},{"group":"Agent URLs","pages":[{"openapi":"get /api/v2/checkAgentUrl","title":"Check agent url availability","href":"/api-reference/agent-urls/check-agent-url-availability"},{"openapi":"get /api/v2/agentUrl","title":"Fetch existing agent url","href":"/api-reference/agent-urls/fetch-existing-agent-url"},{"openapi":"post /api/v2/agentUrl","title":"Create agent url","href":"/api-reference/agent-urls/create-agent-url"}]},{"group":"Accounts","pages":[{"openapi":"post /api/v2/createReseller","title":"Create a new reseller","href":"/api-reference/accounts/create-a-new-reseller"},{"openapi":"get /api/v2/listResellers","title":"List resellers","href":"/api-reference/accounts/list-resellers"},{"openapi":"post /api/v2/createOrganization","title":"Create a new organization","href":"/api-reference/accounts/create-a-new-organization"},{"openapi":"delete /api/v2/deleteOrganization","title":"Delete an organization","href":"/api-reference/accounts/delete-an-organization"},{"openapi":"get /api/v2/listOrganizations","title":"List organizations","href":"/api-reference/accounts/list-organizations"},{"openapi":"get /api/v2/account","title":"Get account details","href":"/api-reference/accounts/get-account-details"},{"openapi":"post /api/v2/account","title":"Update account details","href":"/api-reference/accounts/update-account-details"},{"openapi":"get /api/v2/listAccounts","title":"List agent accounts","href":"/api-reference/accounts/list-agent-accounts"},{"openapi":"post /api/v2/createAccount","title":"Create an agent account","href":"/api-reference/accounts/create-an-agent-account"},{"openapi":"delete /api/v2/deleteAccount","title":"Delete an account","href":"/api-reference/accounts/delete-an-account"},{"openapi":"get /api/v2/members","title":"List members","href":"/api-reference/accounts/list-members"},{"openapi":"get /api/v2/member","title":"Fetch member","href":"/api-reference/accounts/fetch-member"},{"openapi":"put /api/v2/member","title":"Update member","href":"/api-reference/accounts/update-member"},{"openapi":"post /api/v2/member","title":"Invite member","href":"/api-reference/accounts/invite-member"},{"openapi":"delete /api/v2/member","title":"Delete member","href":"/api-reference/accounts/delete-member"},{"openapi":"get /api/v2/searchAccounts","title":"Search accounts","href":"/api-reference/accounts/search-accounts"},{"openapi":"get /api/v2/getAccountByExternalId","title":"Fetch Account by externalAccountId","href":"/api-reference/accounts/fetch-account-by-externalaccountid"},{"openapi":"post /api/v2/updateOrganization","title":"Update Organization Settings","href":"/api-reference/accounts/update-organization-settings"},{"openapi":"post /api/v2/updateAccount","title":"Update Account Settings","href":"/api-reference/accounts/update-account-settings"},{"openapi":"get /api/v2/reseller/settings","title":"Get reseller settings","href":"/api-reference/accounts/get-reseller-settings"},{"openapi":"post /api/v2/reseller/settings","title":"Update reseller settings","href":"/api-reference/accounts/update-reseller-settings"}]},{"group":"Billing","pages":[{"openapi":"get /api/v2/stats/usage","title":"View Usage","href":"/api-reference/billing/view-usage"},{"openapi":"get /api/v2/product/offeredPlan","title":"View Offered Product Plan","href":"/api-reference/billing/view-offered-product-plan"},{"openapi":"get /api/v2/product/currentPlan","title":"View Current Product Plan","href":"/api-reference/billing/view-current-product-plan"},{"openapi":"get /api/v2/product/allAvailablePlans","title":"View Available Product Plans","href":"/api-reference/billing/view-available-product-plans"},{"openapi":"get /api/v2/billing/billingSystemConfig","title":"Get billing provider configuration","href":"/api-reference/billing/get-billing-provider-configuration"},{"openapi":"post /api/v2/billing/billingSystemConfig","title":"Configure a billing provider","href":"/api-reference/billing/configure-a-billing-provider"},{"openapi":"post /api/v2/product/subscribe","title":"Subscribe to product plan","href":"/api-reference/billing/subscribe-to-product-plan"},{"openapi":"delete /api/v2/product/cancel","title":"Cancel product subscription","href":"/api-reference/billing/cancel-product-subscription"},{"openapi":"get /api/v2/addon/available","title":"View Available Add Ons","href":"/api-reference/billing/view-available-add-ons"},{"openapi":"get /api/v2/product/productCatalog","title":"View Product Catalog","href":"/api-reference/billing/view-product-catalog"},{"openapi":"get /api/v2/product/productCatalog/{productPlanId}","title":"Fetch a product plan details","href":"/api-reference/billing/fetch-a-product-plan-details"},{"openapi":"post /api/v2/billing/billingPeriod","title":"Start a new billing period for an organization","href":"/api-reference/billing/start-a-new-billing-period-for-an-organization"},{"openapi":"post /api/v2/billing/adrExportConfig","title":"Configure ADR Export Settings","href":"/api-reference/billing/configure-adr-export-settings"}]},{"group":"Tasks","pages":[{"openapi":"get /api/v2/tasks","title":"Fetch all tasks","href":"/api-reference/tasks/fetch-all-tasks"},{"openapi":"post /api/v2/tasks","title":"Create a new task","href":"/api-reference/tasks/create-a-new-task"},{"openapi":"post /api/v2/tasks/csv","title":"Create multiple tasks via CSV upload","href":"/api-reference/tasks/create-multiple-tasks-via-csv-upload"},{"openapi":"get /api/v2/tasks/stats","title":"Task statistics","href":"/api-reference/tasks/task-statistics"},{"openapi":"get /api/v2/tasks/batches","title":"Recent task batches","href":"/api-reference/tasks/recent-task-batches"},{"openapi":"post /api/v2/tasks/batches","title":"Create a task batch","href":"/api-reference/tasks/create-a-task-batch"},{"openapi":"get /api/v2/tasks/batches/{batchId}","title":"Fetch task batch status","href":"/api-reference/tasks/fetch-task-batch-status"},{"openapi":"get /api/v2/tasks/dailyCounts","title":"Daily counts","href":"/api-reference/tasks/daily-counts"},{"openapi":"get /api/v2/tasks/limits","title":"Fetch task limits","href":"/api-reference/tasks/fetch-task-limits"},{"openapi":"post /api/v2/tasks/limits","title":"Update task limits","href":"/api-reference/tasks/update-task-limits"},{"openapi":"get /api/v2/tasks/{taskId}","title":"Fetch a specific task","href":"/api-reference/tasks/fetch-a-specific-task"},{"openapi":"post /api/v2/tasks/{taskId}","title":"Update a task","href":"/api-reference/tasks/update-a-task"},{"openapi":"delete /api/v2/tasks/{taskId}","title":"Delete a task","href":"/api-reference/tasks/delete-a-task"},{"openapi":"post /api/v2/tasks/{taskId}/run","title":"Run a scheduled Task","href":"/api-reference/tasks/run-a-scheduled-task"},{"openapi":"get /api/v2/tasks/{taskId}/runs","title":"List scheduled Task runs","href":"/api-reference/tasks/list-scheduled-task-runs"},{"openapi":"get /api/v2/tasks/{taskId}/logs","title":"Fetch communication logs for a task","href":"/api-reference/tasks/fetch-communication-logs-for-a-task"},{"openapi":"post /api/v2/tasks/cancel","title":"Cancel queued tasks","href":"/api-reference/tasks/cancel-queued-tasks"}]},{"group":"Integrations","pages":[{"openapi":"get /api/v2/integration/{integrationSlug}/{integrationVersion}","title":"Fetch integration data","href":"/api-reference/integrations/fetch-integration-data"},{"openapi":"put /api/v2/integration/{integrationSlug}/{integrationVersion}","title":"Update integration data","href":"/api-reference/integrations/update-integration-data"}]},{"group":"Models","pages":[{"openapi":"get /api/v2/models/supported","title":"List supported AI models","href":"/api-reference/models/list-supported-ai-models"}]},{"group":"Contacts","pages":[{"openapi":"get /api/v2/contact/list","title":"List Contact Lists","href":"/api-reference/contacts/list-contact-lists"},{"openapi":"get /api/v2/contact/list/{listName}","title":"List Contacts in a Contact List","href":"/api-reference/contacts/list-contacts-in-a-contact-list"},{"openapi":"post /api/v2/contact/list/{listName}","title":"Add or refresh a Contact List membership","href":"/api-reference/contacts/add-or-refresh-a-contact-list-membership"},{"openapi":"delete /api/v2/contact/list/{listName}","title":"Remove a Contact List membership","href":"/api-reference/contacts/remove-a-contact-list-membership"},{"openapi":"get /api/v2/contact","title":"Search and paginate Contacts","href":"/api-reference/contacts/search-and-paginate-contacts"},{"openapi":"post /api/v2/contact","title":"Create or update a Contact","href":"/api-reference/contacts/create-or-update-a-contact"},{"openapi":"delete /api/v2/contact","title":"Delete a Contact","href":"/api-reference/contacts/delete-a-contact"},{"openapi":"delete /api/v2/contact/{contactId}/list/{listName}/state","title":"Remove a Contact from an objective and delete its state","href":"/api-reference/contacts/remove-a-contact-from-an-objective-and-delete-its-state"},{"openapi":"patch /api/v2/contact/{contactId}/list/{listName}/state","title":"Enroll a Contact in an objective and merge its state","href":"/api-reference/contacts/enroll-a-contact-in-an-objective-and-merge-its-state"},{"openapi":"get /api/v2/contact/{contactId}/logs","title":"Fetch recent communication logs for a Contact","href":"/api-reference/contacts/fetch-recent-communication-logs-for-a-contact"},{"openapi":"get /api/v2/contact/{contactId}","title":"Fetch one Contact","href":"/api-reference/contacts/fetch-one-contact"},{"openapi":"patch /api/v2/contact/{contactId}","title":"Partially update a Contact","href":"/api-reference/contacts/partially-update-a-contact"}]},{"group":"White-label Domains","pages":[{"openapi":"get /api/v2/domains","title":"List white-label domains","href":"/api-reference/white-label-domains/list-white-label-domains"},{"openapi":"post /api/v2/domain","title":"Add a white-label domain","href":"/api-reference/white-label-domains/add-a-white-label-domain"},{"openapi":"delete /api/v2/domain","title":"Remove a white-label domain","href":"/api-reference/white-label-domains/remove-a-white-label-domain"},{"openapi":"post /api/v2/domain/default","title":"Set the default white-label domain","description":"Makes one of the authenticated reseller\\'s registered domains the default domain.","href":"/api-reference/white-label-domains/set-the-default-white-label-domain"}]},{"group":"Conversation Logs","pages":[{"openapi":"get /api/v2/logs","title":"Query conversation logs","href":"/api-reference/conversation-logs/query-conversation-logs"},{"openapi":"post /api/v2/logs/timeSeries","title":"Calculate a conversation metric","description":"Calculates an aggregate metric from conversation logs for the selected account and time range. Results can also include time buckets and, for eligible reseller accounts, organization or agent comparisons. Use the normal conversation logs endpoint to inspect the records behind a metric.\n","href":"/api-reference/conversation-logs/calculate-a-conversation-metric"}]},{"group":"Conversations","pages":[{"openapi":"post /api/v2/conversation/batch","title":"Fetch multiple conversations","href":"/api-reference/conversations/fetch-multiple-conversations"},{"openapi":"get /api/v2/conversation/{roomId}/{uuid}","title":"Get a conversation","href":"/api-reference/conversations/get-a-conversation"}]},{"group":"Apps","pages":[{"openapi":"get /api/v2/apps","title":"List agent apps","href":"/api-reference/apps/list-agent-apps"},{"openapi":"get /api/v2/apps/functions","title":"List enabled app functions","href":"/api-reference/apps/list-enabled-app-functions"},{"openapi":"post /api/v2/apps/{appId}/{appVersion}/functions/{functionName}","title":"Run an enabled app function","href":"/api-reference/apps/run-an-enabled-app-function"},{"openapi":"get /api/v2/apps/{appId}/{appVersion}","title":"Get agent app","href":"/api-reference/apps/get-agent-app"},{"openapi":"put /api/v2/apps/{appId}/{appVersion}","title":"Update installed agent app","href":"/api-reference/apps/update-installed-agent-app"},{"openapi":"post /api/v2/apps/{appId}/{appVersion}","title":"Install agent app","href":"/api-reference/apps/install-agent-app"},{"openapi":"delete /api/v2/apps/{appId}/{appVersion}","title":"Uninstall agent app","href":"/api-reference/apps/uninstall-agent-app"}]},{"group":"Inbound Email","pages":[{"openapi":"get /api/v2/email/inboundPolicy","title":"Get the inbound email policy","href":"/api-reference/inbound-email/get-the-inbound-email-policy"},{"openapi":"put /api/v2/email/inboundPolicy","title":"Update the inbound email policy","href":"/api-reference/inbound-email/update-the-inbound-email-policy"},{"openapi":"get /api/v2/email/inboundWhitelist","title":"List allowed inbound email senders","href":"/api-reference/inbound-email/list-allowed-inbound-email-senders"},{"openapi":"post /api/v2/email/inboundWhitelist","title":"Allow an inbound email sender","href":"/api-reference/inbound-email/allow-an-inbound-email-sender"},{"openapi":"delete /api/v2/email/inboundWhitelist","title":"Remove an allowed inbound email sender","href":"/api-reference/inbound-email/remove-an-allowed-inbound-email-sender"}]},{"group":"Features","pages":[{"openapi":"post /api/v2/features/assign","title":"Assign account features","href":"/api-reference/features/assign-account-features"},{"openapi":"delete /api/v2/features/assign","title":"Remove account features","href":"/api-reference/features/remove-account-features"},{"openapi":"get /api/v2/features","title":"List available account features","href":"/api-reference/features/list-available-account-features"}]},{"group":"Computer Agents","pages":[{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/prompts/sync","title":"Refresh Computer Agent instructions","href":"/api-reference/computer-agents/refresh-computer-agent-instructions"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/backup","title":"Create a Computer Agent backup","href":"/api-reference/computer-agents/create-a-computer-agent-backup"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/backups","title":"List Computer Agent backups","href":"/api-reference/computer-agents/list-computer-agent-backups"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/backup-job","title":"Get the latest backup job","href":"/api-reference/computer-agents/get-the-latest-backup-job"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/backup-jobs/{jobId}","title":"Get a backup job","href":"/api-reference/computer-agents/get-a-backup-job"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/restore","title":"Restore a Computer Agent backup","href":"/api-reference/computer-agents/restore-a-computer-agent-backup"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/restore-job","title":"Get the latest restore job","href":"/api-reference/computer-agents/get-the-latest-restore-job"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/restore-jobs/{jobId}","title":"Get a restore job","href":"/api-reference/computer-agents/get-a-restore-job"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/browser/ticket","title":"Create a browser access ticket","href":"/api-reference/computer-agents/create-a-browser-access-ticket"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/browser/automation-sessions","title":"Create a Computer Agent browser automation session","href":"/api-reference/computer-agents/create-a-computer-agent-browser-automation-session"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/canvas","title":"Get Computer Agent Canvas access","href":"/api-reference/computer-agents/get-computer-agent-canvas-access"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/canvas/publish","title":"Publish a Computer Agent Canvas","href":"/api-reference/computer-agents/publish-a-computer-agent-canvas"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/channels/web-login/start","title":"Start a channel web-login flow","href":"/api-reference/computer-agents/start-a-channel-web-login-flow"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/channels/web-login/wait","title":"Wait for a channel web login","href":"/api-reference/computer-agents/wait-for-a-channel-web-login"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/channels/catalog","title":"List supported Computer Agent channels","href":"/api-reference/computer-agents/list-supported-computer-agent-channels"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/channels/status","title":"Get Computer Agent channel status","href":"/api-reference/computer-agents/get-computer-agent-channel-status"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/channels/logout","title":"Log a channel account out","href":"/api-reference/computer-agents/log-a-channel-account-out"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/channels/configure","title":"Configure a Computer Agent channel","href":"/api-reference/computer-agents/configure-a-computer-agent-channel"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/config","title":"Get Computer Agent configuration","href":"/api-reference/computer-agents/get-computer-agent-configuration"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/config/patch","title":"Update Computer Agent configuration","href":"/api-reference/computer-agents/update-computer-agent-configuration"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/helpers","title":"List Computer Agent helpers","href":"/api-reference/computer-agents/list-computer-agent-helpers"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/helpers/execute","title":"Execute a registered Computer Agent helper","href":"/api-reference/computer-agents/execute-a-registered-computer-agent-helper"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/helpers/refresh","title":"Refresh and validate Computer Agent helpers","href":"/api-reference/computer-agents/refresh-and-validate-computer-agent-helpers"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/provision","title":"Provision or reconcile a Computer Agent","href":"/api-reference/computer-agents/provision-or-reconcile-a-computer-agent"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/deprovision","title":"Deprovision a Computer Agent","href":"/api-reference/computer-agents/deprovision-a-computer-agent"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/restart","title":"Restart a Computer Agent","href":"/api-reference/computer-agents/restart-a-computer-agent"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/upgrade","title":"Upgrade a Computer Agent","href":"/api-reference/computer-agents/upgrade-a-computer-agent"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/status","title":"Get Computer Agent status","href":"/api-reference/computer-agents/get-computer-agent-status"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/secrets","title":"List Computer Agent secrets","href":"/api-reference/computer-agents/list-computer-agent-secrets"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/secrets","title":"Save a Computer Agent secret","href":"/api-reference/computer-agents/save-a-computer-agent-secret"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/secrets/delete","title":"Delete a Computer Agent secret","href":"/api-reference/computer-agents/delete-a-computer-agent-secret"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/secrets/check","title":"Check Computer Agent secrets","href":"/api-reference/computer-agents/check-computer-agent-secrets"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/secrets/reapply","title":"Reapply a Computer Agent secret","href":"/api-reference/computer-agents/reapply-a-computer-agent-secret"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/memory/explorer","title":"Explore Computer Agent memories","href":"/api-reference/computer-agents/explore-computer-agent-memories"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/memory","title":"Store a Computer Agent memory","href":"/api-reference/computer-agents/store-a-computer-agent-memory"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/memory/{memoryId}","title":"Update a Computer Agent memory","href":"/api-reference/computer-agents/update-a-computer-agent-memory"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/memory/{memoryId}/delete","title":"Delete a Computer Agent memory","href":"/api-reference/computer-agents/delete-a-computer-agent-memory"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/config/schema","title":"Get available Computer Agent settings","href":"/api-reference/computer-agents/get-available-computer-agent-settings"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/runtime/health","title":"Check Computer Agent health","href":"/api-reference/computer-agents/check-computer-agent-health"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/runtime/logs","title":"Get recent Computer Agent logs","href":"/api-reference/computer-agents/get-recent-computer-agent-logs"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/runtime/service-logs","title":"Get recent Computer Agent service logs","href":"/api-reference/computer-agents/get-recent-computer-agent-service-logs"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/runtime/diagnostics","title":"Diagnose a Computer Agent","href":"/api-reference/computer-agents/diagnose-a-computer-agent"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/runtime/repair","title":"Repair a Computer Agent","href":"/api-reference/computer-agents/repair-a-computer-agent"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/skills/{skillSlug}/auth/{actionId}/start","title":"Start a skill authentication action","href":"/api-reference/computer-agents/start-a-skill-authentication-action"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/skills/{skillSlug}/auth/{actionId}","title":"Get skill authentication action status","href":"/api-reference/computer-agents/get-skill-authentication-action-status"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/skills/{skillSlug}/auth/{actionId}/cancel","title":"Cancel a skill authentication action","href":"/api-reference/computer-agents/cancel-a-skill-authentication-action"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/skills/catalog","title":"List available Computer Agent skills","href":"/api-reference/computer-agents/list-available-computer-agent-skills"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/skills/catalog/{skillSlug}","title":"Get Computer Agent skill details","href":"/api-reference/computer-agents/get-computer-agent-skill-details"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/skills/state","title":"Get installed Computer Agent skills","href":"/api-reference/computer-agents/get-installed-computer-agent-skills"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/skills/{skillSlug}/setup-values","title":"Get a Computer Agent skill setup value","href":"/api-reference/computer-agents/get-a-computer-agent-skill-setup-value"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/skills/install","title":"Install a Computer Agent skill","href":"/api-reference/computer-agents/install-a-computer-agent-skill"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/skills/{skillSlug}/verify","title":"Verify an installed skill","href":"/api-reference/computer-agents/verify-an-installed-skill"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/skills/{skillSlug}/disable","title":"Disable an installed skill","href":"/api-reference/computer-agents/disable-an-installed-skill"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/skills/{skillSlug}/uninstall","title":"Uninstall an installed skill","href":"/api-reference/computer-agents/uninstall-an-installed-skill"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/skills/{skillSlug}/setup-state","title":"Save a Computer Agent skill setting","href":"/api-reference/computer-agents/save-a-computer-agent-skill-setting"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/tasks/execute","title":"Execute a Computer Task and wait for its result","href":"/api-reference/computer-agents/execute-a-computer-task-and-wait-for-its-result"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/tasks/{taskId}/result","title":"Read or wait for a Computer Task result","href":"/api-reference/computer-agents/read-or-wait-for-a-computer-task-result"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/tools/catalog","title":"List Computer Agent tools and policy","href":"/api-reference/computer-agents/list-computer-agent-tools-and-policy"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/tools/policy","title":"Change one Computer Agent tool policy","href":"/api-reference/computer-agents/change-one-computer-agent-tool-policy"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/tools/invoke","title":"Run an allowed Computer Agent tool","href":"/api-reference/computer-agents/run-an-allowed-computer-agent-tool"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/workflow-recordings/status","title":"Get browser workflow status","href":"/api-reference/computer-agents/get-browser-workflow-status"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workflow-recordings/start","title":"Start recording a browser workflow","href":"/api-reference/computer-agents/start-recording-a-browser-workflow"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workflow-recordings/stop","title":"Stop recording a browser workflow","href":"/api-reference/computer-agents/stop-recording-a-browser-workflow"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workflow-recordings/{domainKey}/{recordingId}/commentary","title":"Add guidance to a browser workflow recording","href":"/api-reference/computer-agents/add-guidance-to-a-browser-workflow-recording"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workflow-recordings/{domainKey}/{recordingId}/delete","title":"Delete a browser workflow recording","href":"/api-reference/computer-agents/delete-a-browser-workflow-recording"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workflow-recordings/{domainKey}/generate","title":"Generate a reusable browser helper","href":"/api-reference/computer-agents/generate-a-reusable-browser-helper"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workflow-recordings/{domainKey}/reset","title":"Reset a generated browser helper","href":"/api-reference/computer-agents/reset-a-generated-browser-helper"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workspace/read","title":"Read a Computer Agent workspace file","href":"/api-reference/computer-agents/read-a-computer-agent-workspace-file"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workspace/write","title":"Write a Computer Agent workspace file","href":"/api-reference/computer-agents/write-a-computer-agent-workspace-file"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workspace/upload","title":"Upload a Computer Agent workspace file","href":"/api-reference/computer-agents/upload-a-computer-agent-workspace-file"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workspace/list","title":"List a Computer Agent workspace directory","href":"/api-reference/computer-agents/list-a-computer-agent-workspace-directory"},{"openapi":"delete /api/v2/computer/accounts/{targetAccountId}/workspace/delete","title":"Delete a Computer Agent workspace path","href":"/api-reference/computer-agents/delete-a-computer-agent-workspace-path"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/workspace/download","title":"Download a Computer Agent workspace file","href":"/api-reference/computer-agents/download-a-computer-agent-workspace-file"},{"openapi":"get /api/v2/computer/accounts/{targetAccountId}/workspace/preview","title":"Preview a Computer Agent workspace file","href":"/api-reference/computer-agents/preview-a-computer-agent-workspace-file"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workspace/edit","title":"Replace text in a Computer Agent workspace file","href":"/api-reference/computer-agents/replace-text-in-a-computer-agent-workspace-file"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workspace/find","title":"Find workspace paths","href":"/api-reference/computer-agents/find-workspace-paths"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/workspace/search","title":"Search text in a Computer Agent workspace","href":"/api-reference/computer-agents/search-text-in-a-computer-agent-workspace"},{"openapi":"get /api/v2/computer/accounts","title":"List Computer Agent accounts","href":"/api-reference/computer-agents/list-computer-agent-accounts"}]},{"group":"Computer Agent Sessions","pages":[{"openapi":"get /api/v2/computer/sessions","title":"List Computer Agent sessions","href":"/api-reference/computer-agent-sessions/list-computer-agent-sessions"},{"openapi":"post /api/v2/computer/sessions/reset","title":"Reset a Computer Agent session","href":"/api-reference/computer-agent-sessions/reset-a-computer-agent-session"},{"openapi":"post /api/v2/computer/accounts/{targetAccountId}/session/resolve","title":"Find a Computer Agent session chat","href":"/api-reference/computer-agent-sessions/find-a-computer-agent-session-chat"}]},{"group":"Agent Templates","pages":[{"openapi":"post /api/v2/prefillTemplateFromWeb","title":"Suggest template fields from a website","href":"/api-reference/agent-templates/suggest-template-fields-from-a-website"},{"openapi":"post /api/v2/createAgentFromTemplate","title":"Create an Agent from a template","href":"/api-reference/agent-templates/create-an-agent-from-a-template"},{"openapi":"post /api/v2/detachAgentFromTemplate","title":"Detach an Agent from its template","href":"/api-reference/agent-templates/detach-an-agent-from-its-template"},{"openapi":"post /api/v2/templates/{templateId}/migrate","title":"Migrate Agents to a template revision","href":"/api-reference/agent-templates/migrate-agents-to-a-template-revision"},{"openapi":"get /api/v2/templates/{templateId}/migrations","title":"List template migrations","href":"/api-reference/agent-templates/list-template-migrations"},{"openapi":"get /api/v2/templates/{templateId}/migrations/{taskId}","title":"Get a template migration","href":"/api-reference/agent-templates/get-a-template-migration"},{"openapi":"get /api/v2/templates","title":"List Agent templates","href":"/api-reference/agent-templates/list-agent-templates"},{"openapi":"post /api/v2/templates/createTemplate","title":"Create an Agent template draft","href":"/api-reference/agent-templates/create-an-agent-template-draft"},{"openapi":"get /api/v2/templates/{templateId}","title":"Get an Agent template","href":"/api-reference/agent-templates/get-an-agent-template"},{"openapi":"post /api/v2/templates/{templateId}","title":"Update an Agent template","href":"/api-reference/agent-templates/update-an-agent-template"},{"openapi":"delete /api/v2/templates/{templateId}","title":"Delete an Agent template","href":"/api-reference/agent-templates/delete-an-agent-template"}]}]}]},"basePath":"","title":"Vida AI Agent OS Documentation","buildId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","deploymentId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CW3yP2DK.js","utils-BN0nty2W.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C8_MydSG.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bsl5xDMQ.js","snippetPresets-DYv9OBej.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-9OnYPrVf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-xr67xWGO.js","shallow-DO1aDdBF.js","getApiPlaygroundDisplay-o7cLzFL-.js","CodeSnippet-CGr2yOA8.js","CodeSnippets-CzBbqPNh.js","Page-CBlOSKZG.js","getPastedJson-dpi9sn5Y.js","icon-aIWHt8Pn.js","MethodPill-Bv2zLsGY.js","DuplicateIcon-DxFSz0J6.js","createIcon-uDNv6jwj.js","DynamicMarkdown-C91yhnNP.js","SectionHeading-DG_xjOLR.js","axios-vUo_bRtp.js","Markdown-B4M_Eo1P.js","clsx-DShopWo_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BX6wab7q.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-48h67xm_.js"]}