API key: key id as the username, secret as the password. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Guild","description":"Guild is the control plane for AI agents: build, run, and manage agents across workspaces, trigger them from events, schedules, or API calls, and hold conversations with them programmatically.","colors":{"primary":"#ff5500","light":"#ff5500","dark":"#ff5500"},"logo":{"light":"https://mintcdn.com/guildai/x-xVeOd53CpYbehm/logo/light.svg?fit=max\u0026auto=format\u0026n=x-xVeOd53CpYbehm\u0026q=85\u0026s=21393c9a072674c192091492cc76f441","dark":"https://mintcdn.com/guildai/x-xVeOd53CpYbehm/logo/dark.svg?fit=max\u0026auto=format\u0026n=x-xVeOd53CpYbehm\u0026q=85\u0026s=d6acfb4e042a02c7229b6dea41c1a957"},"favicon":{"light":"https://mintcdn.com/guildai/bdwyr8JP4_t-g2mL/favicon-tile-light.svg?fit=max\u0026auto=format\u0026n=bdwyr8JP4_t-g2mL\u0026q=85\u0026s=73d1ea692ac79392f47f8b39f0c99cc7","dark":"https://mintcdn.com/guildai/bdwyr8JP4_t-g2mL/favicon-tile-dark.svg?fit=max\u0026auto=format\u0026n=bdwyr8JP4_t-g2mL\u0026q=85\u0026s=2e6fbb5bd798a31616692175082e7681"},"appearance":{"default":"dark"},"background":{"color":{"light":"#fafafa","dark":"#191919"}},"navbar":{"links":[{"href":"https://guild.ai","label":"guild.ai"}],"primary":{"type":"button","label":"Sign in","href":"https://app.guild.ai"}},"footer":{"socials":{"github":"https://github.com/guildaidev","discord":"https://discord.gg/guild-ai"},"links":[{"header":"Company","items":[{"label":"About","href":"https://www.guild.ai/about"},{"label":"Contact","href":"https://www.guild.ai/contact"},{"label":"Privacy policy","href":"https://www.guild.ai/privacy-policy"},{"label":"Terms","href":"https://www.guild.ai/terms"}]}]},"seo":{"metatags":{"og:site_name":"Guild Docs"},"organization":{"id":"https://www.guild.ai/#organization","name":"Guild","legalName":"Guild.ai, Inc.","url":"https://www.guild.ai/","sameAs":["https://www.linkedin.com/company/guild-ai-group","https://x.com/GuildAI","https://www.crunchbase.com/organization/guild-ai-86ce","https://www.threads.com/@guild.ai","https://reddit.com/r/guildai","https://youtube.com/@guild-ai","https://www.wikidata.org/wiki/Q141717471","https://github.com/guildaidev","https://discord.gg/guild-ai","https://instagram.com/guild.ai"]}},"fonts":{"family":"Geist"},"errors":{"404":{"redirect":false,"title":"Page not found","description":"That page doesn't exist. Try the [homepage](/), the full [documentation index](/llms.txt), or the [API reference](/api-reference/introduction)."}},"contextual":{"options":["copy","chatgpt","claude","mcp","cursor","vscode","download-spec"],"display":"header"},"metadata":{"timestamp":true},"markdown":{"instructions":["To act on a user's behalf in Guild, use the Guild REST API at https://api.guild.ai/v1.","The OpenAPI spec is unauthenticated: https://docs.guild.ai/openapi.json (or openapi.yaml).","Authenticate with an account API key, sent as HTTP Basic (key id as username, secret as password) or as `Authorization: Bearer \u003capi_key_id>:\u003capi_key_secret>`. See https://docs.guild.ai/api-reference/introduction#authentication.","To run one agent on demand without account-wide access, use an API trigger instead: https://docs.guild.ai/platform/api-triggers.","To act on Guild from an MCP client, connect to https://api.guild.ai/mcp (OAuth) or run `guild mcp` locally. Setup: https://docs.guild.ai/api-reference/mcp.","To search these docs from an MCP client, connect to https://docs.guild.ai/mcp. The full page index is https://docs.guild.ai/llms.txt."]},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"guildai","hasAudioNarration":false,"actualSubdomain":"guildai","customDomains":["docs.guild.ai"],"gitSource":{"type":"github","owner":"guildaidev","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aebdc4ac42c650b17a2f968","collectionId":"e79d1675-0681-469e-98df-d4cbd0b2816c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebdc4ac42c650b17a2f968"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aebdc4ac42c650b17a2f968","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":89},{"language":"default","tag":"Guides","count":86},{"language":"default","tag":"Integrations","count":57},{"language":"default","tag":"Platform","count":54},{"language":"default","tag":"CLI","count":48},{"language":"default","tag":"Agents","count":34},{"language":"default","tag":"Workspaces","count":25},{"language":"default","tag":"Access \u0026 setup","count":22},{"language":"default","tag":"Commands","count":18},{"language":"default","tag":"Triggers","count":18}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","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":"vite-origin","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":"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}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--gray-50: 250 250 250;--gray-100: 245 245 245;--gray-200: 229 229 229;--gray-300: 212 212 212;--gray-400: 163 163 163;--gray-500: 115 115 115;--gray-600: 82 82 82;--gray-700: 64 64 64;--gray-800: 38 38 38;--gray-900: 23 23 23;--gray-950: 10 10 10}:root:not(.dark) :not(pre)>code{background-color:rgba(0, 0, 0, 0.04)!important;color:rgb(var(--gray-700))!important}.dark :not(pre)>code{background-color:rgba(255, 255, 255, 0.08)!important;color:rgb(var(--gray-300))!important}:root{--guild-accent: #ff5500;--guild-hairline: #eeeeed;--guild-muted: #746f6c}.dark{--guild-hairline: rgba(255, 255, 255, 0.12);--guild-muted: rgb(var(--gray-400))}.guild-logo{display:flex;align-items:center;justify-content:center;width:48px;height:48px;flex:none;border:1px solid var(--guild-hairline);border-radius:12px;margin:0 0 1.5rem}*:has(>.mdx-content>.guild-lockup:first-child){position:relative}*:has(>.mdx-content>.guild-lockup:first-child)>header{padding-top:4rem}.mdx-content:has(>.guild-lockup:first-child){position:static}.mdx-content>.guild-lockup:first-child{position:absolute;top:1.5rem;inset-inline-start:1.5rem;margin:0;display:flex;align-items:center;gap:0.875rem}.guild-lockup .guild-logo{margin:0}.guild-eyebrow{display:inline-flex;align-items:center;gap:0.5rem;font-size:0.8125rem;line-height:1;letter-spacing:0.01em;color:var(--guild-muted)}.guild-eyebrow::before{content:\"\";width:4px;height:4px;flex:none;background:var(--guild-accent)}.guild-logo svg,.guild-logo img{display:block;width:20px;height:20px}.integration-cards [data-component-part=\"card-content-container\"],.integration-cards [data-component-part=\"card-content-container\"] div.w-full{display:flex;flex-direction:column}.integration-cards [data-component-part=\"card-content-container\"]{gap:1rem}.integration-cards div.w-full{gap:0.25rem}.integration-cards [data-component-part=\"card-title\"],.integration-cards [data-component-part=\"card-content\"]{margin-top:0}.integration-cards [data-component-part=\"card-icon\"]{display:flex;align-items:center;width:auto;height:1.5rem}.integration-cards [data-component-part=\"card-icon\"]>img{width:auto!important;height:auto!important;max-width:none;filter:brightness(0)}.dark .integration-cards [data-component-part=\"card-icon\"]>img{filter:brightness(0) invert(1)}img[src*=\"/images/integration_marks/\"]{object-fit:contain;filter:brightness(0)}.dark img[src*=\"/images/integration_marks/\"]{filter:brightness(0) invert(1)}#sidebar-content img[src*=\"/images/integration_marks/\"]{filter:brightness(0) invert(0.64)}.dark #sidebar-content img[src*=\"/images/integration_marks/\"]{filter:brightness(0) invert(0.45)}.integration-cards [data-component-part=\"card-icon\"]>svg{width:1.25rem!important;height:1.25rem!important;background-color:currentColor!important}"}],"page":{"pagePath":"api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark","slug":"/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark","pageMetadata":{"title":"Observe the root task after a send-time session event watermark","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}/wait","href":"/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark","autogeneratedByOpenApi":true},"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":{"title":"Observe the root task after a send-time session event watermark","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}/wait","href":"/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/guildai/f8155b48b6398768/webmcp.js"],"openApiReferenceData":{"operation":{"operationId":"gen_wait_for_session","summary":"Observe the root task after a send-time session event watermark","tags":["sessions"],"security":["36809778-f221-4c82-98d2-fdce76c3dac2","4538e3b8-34c8-4888-8c9c-eda7525a82d0","df738e39-ecdd-4140-a5e9-f92ee452cbb6"],"parameters":["dd918915-ed01-47f2-80c5-feecc5a8d63b","71c76464-b800-4103-b26d-00df60ed5ad6","a2fddea3-9ca0-4e5d-9d96-9750931d54df","0a34cd13-665c-43f0-845e-18eb6856d53a"],"responses":{"200":"c4f1ab47-5557-43ed-b0bb-daed60248977","401":"9009ce37-422e-4f98-81f4-22c3bbd63624","404":"e5757b44-b87f-4329-b551-18b11e433091"},"x-guild-response-model":"WaitForSessionResponse","method":"get","type":"path","servers":["8b14fa60-0709-42c8-9072-66b10e4f9726"],"path":"/sessions/{session_id}/wait","baseUrlOptions":["https://api.guild.ai/v1"],"title":"Observe the root task after a send-time session event watermark","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"dd918915-ed01-47f2-80c5-feecc5a8d63b":{"name":"session_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"71c76464-b800-4103-b26d-00df60ed5ad6":{"name":"user_event_id","in":"query","required":true,"schema":{"description":"The user message event ID returned by the send call","title":"User Event Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"a2fddea3-9ca0-4e5d-9d96-9750931d54df":{"name":"after_event_id","in":"query","required":true,"schema":{"oneOf":[{"type":"string","title":"After Event Id","description":"Forward the wait_after_event_id returned by the send call unchanged; start denotes an empty snapshot","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"string","title":"After Event Id","description":"Forward the wait_after_event_id returned by the send call unchanged; start denotes an empty snapshot","enum":["start"],"isRequired":true,"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid> | enum\u003cstring>"}},"0a34cd13-665c-43f0-845e-18eb6856d53a":{"name":"timeout_seconds","in":"query","required":false,"schema":{"oneOf":[{"default":null,"description":"Optional wait in seconds, capped by the server's configured window; expiry returns wait_complete=false without stopping the session","title":"Timeout Seconds","exclusiveMinimum":true,"type":"number","minimum":0,"uniqueKey":"oneOf.0","typeLabel":"number"},{"default":null,"description":"Optional wait in seconds, capped by the server's configured window; expiry returns wait_complete=false without stopping the session","title":"Timeout Seconds","exclusiveMinimum":true,"type":"null","minimum":0,"uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"}}},"responses":{"c4f1ab47-5557-43ed-b0bb-daed60248977":{"description":"Successful response","content":{"application/json":{"schema":{"properties":{"session_id":{"title":"Session Id","type":"string","isRequired":true,"uniqueKey":"session_id","typeLabel":"string"},"task_id":{"title":"Task Id","type":"string","isRequired":true,"uniqueKey":"task_id","typeLabel":"string"},"user_event_id":{"title":"User Event Id","type":"string","isRequired":true,"uniqueKey":"user_event_id","typeLabel":"string"},"after_event_id":{"title":"After Event Id","type":"string","isRequired":true,"uniqueKey":"after_event_id","typeLabel":"string"},"completion_scope":{"title":"Completion Scope","type":"string","enum":["root_task_state"],"isRequired":true,"uniqueKey":"completion_scope","typeLabel":"enum\u003cstring>"},"message_consumed":{"title":"Message Consumed","type":"string","enum":["unconfirmed"],"isRequired":true,"uniqueKey":"message_consumed","typeLabel":"enum\u003cstring>"},"wait_complete":{"title":"Wait Complete","type":"boolean","isRequired":true,"uniqueKey":"wait_complete","typeLabel":"boolean"},"status":{"oneOf":[{"default":null,"title":"Status","type":"string","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"default":null,"title":"Status","type":"null","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"string | null"},"event":{"oneOf":[{"default":null,"title":"Event","additionalProperties":true,"type":"object","uniqueKey":"event.oneOf.0","typeLabel":"Event · object"},{"default":null,"title":"Event","additionalProperties":true,"type":"null","uniqueKey":"event.oneOf.1","typeLabel":"null"}],"uniqueKey":"event","typeLabel":"Event · object | null"},"action":{"oneOf":[{"type":"object","title":"WaitAction","required":["type","task_id"],"properties":{"type":{"enum":["user_input","credentials","agent_install"],"title":"Type","type":"string","isRequired":true,"uniqueKey":"action.oneOf.0.type","typeLabel":"enum\u003cstring>"},"task_id":{"title":"Task Id","type":"string","isRequired":true,"uniqueKey":"action.oneOf.0.task_id","typeLabel":"string"},"event":{"oneOf":[{"default":null,"title":"Event","additionalProperties":true,"type":"object","uniqueKey":"action.oneOf.0.event.oneOf.0","typeLabel":"Event · object"},{"default":null,"title":"Event","additionalProperties":true,"type":"null","uniqueKey":"action.oneOf.0.event.oneOf.1","typeLabel":"null"}],"uniqueKey":"action.oneOf.0.event","typeLabel":"Event · object | null"}},"uniqueKey":"action.oneOf.0","typeLabel":"WaitAction · object"},{"enum":[null],"uniqueKey":"action.oneOf.1","typeLabel":"any"},{"type":"null","enum":[null],"uniqueKey":"action.oneOf.2","typeLabel":"null"},{"type":"null","uniqueKey":"action.oneOf.3","typeLabel":"null"}],"uniqueKey":"action","typeLabel":"WaitAction · object · any · null · null"}},"required":["session_id","task_id","user_event_id","after_event_id","completion_scope","message_consumed","wait_complete"],"title":"WaitForSessionResponse","type":"object","uniqueKey":"","typeLabel":"WaitForSessionResponse · object"},"examples":{"Example":{"title":"Example","value":{"session_id":"\u003cstring>","task_id":"\u003cstring>","user_event_id":"\u003cstring>","after_event_id":"\u003cstring>","completion_scope":"root_task_state","message_consumed":"unconfirmed","wait_complete":true,"status":null,"event":null,"action":{"type":"user_input","task_id":"\u003cstring>","event":null}}}},"exampleType":"generated"}},"exampleType":"generated"},"9009ce37-422e-4f98-81f4-22c3bbd63624":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e5757b44-b87f-4329-b551-18b11e433091":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"36809778-f221-4c82-98d2-fdce76c3dac2":{"apiKey":{"type":"http","scheme":"basic","description":"API key: key id as the username, secret as the password. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","scopes":[],"schemeName":"apiKey"}},"4538e3b8-34c8-4888-8c9c-eda7525a82d0":{"bearerApiKey":{"type":"http","scheme":"bearer","bearerFormat":"\u003ckey id>:\u003csecret>","description":"The same API key as one Bearer token, `\u003ckey id>:\u003csecret>`. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","scopes":[],"schemeName":"bearerApiKey"}},"df738e39-ecdd-4140-a5e9-f92ee452cbb6":{"oauth2":{"type":"oauth2","description":"OAuth 2.0 authorization code flow with PKCE (S256). Discovery: https://api.guild.ai/.well-known/oauth-authorization-server.","flows":{"authorizationCode":{"authorizationUrl":"https://api.guild.ai/v1/oauth/authorize","tokenUrl":"https://api.guild.ai/v1/oauth/token","refreshUrl":"https://api.guild.ai/v1/oauth/token","scopes":{"agents:read":"Read agents","agents:write":"Read and change agents","sessions:read":"Read sessions","sessions:write":"Read and change sessions","workspaces:read":"Read workspaces","workspaces:write":"Read and change workspaces","skills:read":"Read skills","skills:write":"Read and change skills","integrations:read":"Read integrations","integrations:write":"Read and change integrations","applications:read":"Read applications","applications:write":"Read and change applications","organizations:read":"Read organizations","organizations:write":"Read and change organizations","usage:read":"Read usage","usage:write":"Read and change usage"}}},"scopes":["sessions:read"],"schemeName":"oauth2"}}},"servers":{"8b14fa60-0709-42c8-9072-66b10e4f9726":{"url":"https://api.guild.ai/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"API key: key id as the username, secret as the password. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Basic Auth","type":"object","description":"API key: key id as the username, secret as the password. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"\u003ckey id>:\u003csecret>","description":"The same API key as one Bearer token, `\u003ckey id>:\u003csecret>`. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","scopes":[],"schemeName":"bearerApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The same API key as one Bearer token, `\u003ckey id>:\u003csecret>`. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerApiKey","name":"Authorization"}],"title":"bearerApiKey"},{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth 2.0 authorization code flow with PKCE (S256). Discovery: https://api.guild.ai/.well-known/oauth-authorization-server.","flows":{"authorizationCode":{"authorizationUrl":"https://api.guild.ai/v1/oauth/authorize","tokenUrl":"https://api.guild.ai/v1/oauth/token","refreshUrl":"https://api.guild.ai/v1/oauth/token","scopes":{"agents:read":"Read agents","agents:write":"Read and change agents","sessions:read":"Read sessions","sessions:write":"Read and change sessions","workspaces:read":"Read workspaces","workspaces:write":"Read and change workspaces","skills:read":"Read skills","skills:write":"Read and change skills","integrations:read":"Read integrations","integrations:write":"Read and change integrations","applications:read":"Read applications","applications:write":"Read and change applications","organizations:read":"Read organizations","organizations:write":"Read and change organizations","usage:read":"Read usage","usage:write":"Read and change usage"}}},"scopes":["sessions:read"],"schemeName":"oauth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth 2.0 authorization code flow with PKCE (S256). Discovery: https://api.guild.ai/.well-known/oauth-authorization-server.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"guildai","siteName":"Guild","title":"Observe the root task after a send-time session event watermark - Guild","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;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=\"dark\"}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=\"application-name\" content=\"Guild\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_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=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Observe the root task after a send-time session event watermark - Guild\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Guild Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.guild.ai/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://guildai.mintlify.app/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Observe+the+root+task+after+a+send-time+session+event+watermark\u0026amp;theme=fd45c57432bade890a72344e\u0026amp;signature=d5e2ede30279bf44f7273fcf040fcf2c36d5396cb0fe5fa2fa766b7e62392eb9\">\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=\"Observe the root task after a send-time session event watermark - Guild\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://guildai.mintlify.app/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Observe+the+root+task+after+a+send-time+session+event+watermark\u0026amp;theme=fd45c57432bade890a72344e\u0026amp;signature=d5e2ede30279bf44f7273fcf040fcf2c36d5396cb0fe5fa2fa766b7e62392eb9\">\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=\"/mintlify-assets/_mintlify/favicons/guildai/co0AUpnLd7CKemzr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Guild\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff5500\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.guild.ai/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.guild.ai/#organization\",\"name\":\"Guild\",\"legalName\":\"Guild.ai, Inc.\",\"url\":\"https://www.guild.ai/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/guildai/x-xVeOd53CpYbehm/logo/light.svg?fit=max\u0026auto=format\u0026n=x-xVeOd53CpYbehm\u0026q=85\u0026s=21393c9a072674c192091492cc76f441\"},\"sameAs\":[\"https://www.linkedin.com/company/guild-ai-group\",\"https://x.com/GuildAI\",\"https://www.crunchbase.com/organization/guild-ai-86ce\",\"https://www.threads.com/@guild.ai\",\"https://reddit.com/r/guildai\",\"https://youtube.com/@guild-ai\",\"https://www.wikidata.org/wiki/Q141717471\",\"https://github.com/guildaidev\",\"https://discord.gg/guild-ai\",\"https://instagram.com/guild.ai\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.guild.ai#website\",\"name\":\"Guild\",\"url\":\"https://docs.guild.ai\",\"publisher\":{\"@id\":\"https://www.guild.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.guild.ai/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark#webpage\",\"url\":\"https://docs.guild.ai/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark\",\"name\":\"Observe the root task after a send-time session event watermark\",\"isPartOf\":{\"@id\":\"https://docs.guild.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.guild.ai/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.guild.ai/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sessions\",\"item\":\"https://docs.guild.ai/api-reference/sessions/get-a-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Observe the root task after a send-time session event watermark\",\"item\":\"https://docs.guild.ai/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.guild.ai/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark#apireference\",\"headline\":\"Observe the root task after a send-time session event watermark\",\"name\":\"Observe the root task after a send-time session event watermark\",\"url\":\"https://docs.guild.ai/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark\",\"mainEntityOfPage\":{\"@id\":\"https://docs.guild.ai/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark#webpage\"},\"publisher\":{\"@id\":\"https://www.guild.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.guild.ai#website\"}}]}\u003c/script>","siteName":"Guild","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"CLI","icon":"terminal","pages":[{"title":"CLI","href":"/cli/getting-started"}]},{"tab":"SDK","icon":"code","pages":[{"title":"SDK","href":"/packages/agents-sdk"}]},{"tab":"API Reference","icon":"server","groups":[{"group":"Get Started","pages":[{"title":"Developers","href":"/developers"},{"title":"Guild API overview","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"Agent sessions API","sidebarTitle":"Conversations","href":"/api-reference/conversations"},{"title":"Connect an MCP client","sidebarTitle":"MCP","href":"/api-reference/mcp"},{"title":"Versioning and changes","sidebarTitle":"Versioning","href":"/api-reference/versioning"},{"title":"Errors and troubleshooting","sidebarTitle":"Errors","href":"/reference/errors"}]},{"group":"OAuth","pages":[{"title":"OAuth discovery","href":"/api-reference/oauth-discovery"},{"title":"Register an OAuth client","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /oauth/register","href":"/api-reference/oauth/register-an-oauth-client"},{"title":"Start an OAuth authorization by redirecting to the consent page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /oauth/authorize","href":"/api-reference/oauth/start-an-oauth-authorization-by-redirecting-to-the-consent-page"},{"title":"Exchange an authorization code or refresh token for an access token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /oauth/token","href":"/api-reference/oauth/exchange-an-authorization-code-or-refresh-token-for-an-access-token"}]},{"group":"Workspaces","pages":[{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces","href":"/api-reference/workspaces/create-a-workspace"},{"title":"Get a workspace and its compiled context","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}","href":"/api-reference/workspaces/get-a-workspace-and-its-compiled-context"},{"title":"List the current user's workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /me/workspaces","href":"/api-reference/workspaces/list-the-current-users-workspaces"},{"title":"List a workspace's members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/memberships","href":"/api-reference/workspaces/list-a-workspaces-members"},{"title":"List the agents installed in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/workspace_agents","href":"/api-reference/workspaces/list-the-agents-installed-in-a-workspace"},{"title":"Install an agent in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces/{workspace_id_or_name}/workspace_agents","href":"/api-reference/workspaces/install-an-agent-in-a-workspace"},{"title":"Get an installed agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspace_agents/{workspace_agent_id}","href":"/api-reference/workspaces/get-an-installed-agent"},{"title":"Update an installed agent's version or settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /workspace_agents/{workspace_agent_id}","href":"/api-reference/workspaces/update-an-installed-agents-version-or-settings"},{"title":"Uninstall an agent from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /workspace_agents/{workspace_agent_id}","href":"/api-reference/workspaces/uninstall-an-agent-from-a-workspace"},{"title":"List an installed agent's version upgrades","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspace_agents/{workspace_agent_id}/upgrades","href":"/api-reference/workspaces/list-an-installed-agents-version-upgrades"},{"title":"List the credentials granted to an installed agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspace_agents/{workspace_agent_id}/credential-associations","href":"/api-reference/workspaces/list-the-credentials-granted-to-an-installed-agent"},{"title":"Grant a credential to an installed agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspace_agents/{workspace_agent_id}/credential-associations","href":"/api-reference/workspaces/grant-a-credential-to-an-installed-agent"},{"title":"Revoke a credential from an installed agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /workspace_agents/{workspace_agent_id}/credential-associations/{association_id}","href":"/api-reference/workspaces/revoke-a-credential-from-an-installed-agent"},{"title":"Create a dedicated API-key credential for a workspace agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspace_agents/{workspace_agent_id}/credentials/api-key","href":"/api-reference/workspaces/create-a-dedicated-api-key-credential-for-a-workspace-agent"},{"title":"List the skills attached to a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/workspace_skills","href":"/api-reference/workspaces/list-the-skills-attached-to-a-workspace"},{"title":"Attach a skill to a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces/{workspace_id_or_name}/workspace_skills","href":"/api-reference/workspaces/attach-a-skill-to-a-workspace"},{"title":"Detach a skill from a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /workspaces/{workspace_id_or_name}/workspace_skills/{workspace_skill_id}","href":"/api-reference/workspaces/detach-a-skill-from-a-workspace"},{"title":"List a workspace's contexts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/contexts","href":"/api-reference/workspaces/list-a-workspaces-contexts"},{"title":"Create a workspace context","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces/{workspace_id_or_name}/contexts","href":"/api-reference/workspaces/create-a-workspace-context"},{"title":"List a workspace's sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/sessions","href":"/api-reference/workspaces/list-a-workspaces-sessions"},{"title":"Create a session in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces/{workspace_id_or_name}/sessions","href":"/api-reference/workspaces/create-a-session-in-a-workspace"}]},{"group":"Triggers","pages":[{"title":"List a workspace's triggers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /workspaces/{workspace_id_or_name}/triggers","href":"/api-reference/workspaces/list-a-workspaces-triggers"},{"title":"Create a trigger in a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /workspaces/{workspace_id_or_name}/triggers","href":"/api-reference/workspaces/create-a-trigger-in-a-workspace"},{"title":"Get a trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /triggers/{trigger_id}","href":"/api-reference/triggers/get-a-trigger"},{"title":"Update a trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /triggers/{trigger_id}","href":"/api-reference/triggers/update-a-trigger"},{"title":"Delete a trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /triggers/{trigger_id}","href":"/api-reference/triggers/delete-a-trigger"},{"title":"Activate a trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /triggers/{trigger_id}/activate","href":"/api-reference/triggers/activate-a-trigger"},{"title":"Deactivate a trigger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /triggers/{trigger_id}/deactivate","href":"/api-reference/triggers/deactivate-a-trigger"},{"title":"Run a scheduled trigger now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /triggers/{trigger_id}/run","href":"/api-reference/triggers/run-a-scheduled-trigger-now"},{"title":"List the sessions a trigger started","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /triggers/{trigger_id}/sessions","href":"/api-reference/triggers/list-the-sessions-a-trigger-started"}]},{"group":"Agents","pages":[{"title":"List and search agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents","href":"/api-reference/agents/list-and-search-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /agents","href":"/api-reference/agents/create-an-agent"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents/{agent_id_or_name}","href":"/api-reference/agents/get-an-agent"},{"title":"Update an agent's visibility, archive state or pin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /agents/{agent_id_or_name}","href":"/api-reference/agents/update-an-agents-visibility-archive-state-or-pin"},{"title":"Returns the latest version of this agent's code. Note that by default, it returns only PUBLISHED versions. You can specify ?include_unpublished=true to get the actual latest","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents/{agent_id_or_name}/code","href":"/api-reference/agents/returns-the-latest-version-of-this-agents-code-note-that-by-default-it-returns-only-published-versions-you-can-specify-?include_unpublished=true-to-get-the-actual-latest"},{"title":"Commit a new version of an LLM agent with the given tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /agents/{agent_id_or_name}/configure-llm","href":"/api-reference/agents/commit-a-new-version-of-an-llm-agent-with-the-given-tools"},{"title":"Wait for an agent's initialization to reach READY","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents/{agent_id_or_name}/wait","href":"/api-reference/agents/wait-for-an-agents-initialization-to-reach-ready"}]},{"group":"Agent versions","pages":[{"title":"List an agent's versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /agents/{agent_id_or_name}/versions","href":"/api-reference/agents/list-an-agents-versions"},{"title":"Create an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /agents/{agent_id_or_name}/versions","href":"/api-reference/agents/create-an-agent-version"},{"title":"Get an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}","href":"/api-reference/agents/get-an-agent-version"},{"title":"Get an agent version's source files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/code","href":"/api-reference/agents/get-an-agent-versions-source-files"},{"title":"List a version's resolved tools: integration, sub-agent or service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/tools","href":"/api-reference/agents/list-a-versions-resolved-tools:-integration-sub-agent-or-service"},{"title":"Classify each of a version's tools as read or write","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/tool-access","href":"/api-reference/agents/classify-each-of-a-versions-tools-as-read-or-write"},{"title":"Revalidate a version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /agents/{agent_id_or_name}/versions/{version_id}/revalidate","href":"/api-reference/agents/revalidate-a-version"},{"title":"Get latest validation job for an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/validation/job","href":"/api-reference/agents/get-latest-validation-job-for-an-agent-version"},{"title":"List validation steps for an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/validation/steps","href":"/api-reference/agents/list-validation-steps-for-an-agent-version"},{"title":"Run the checks a version must pass before publishing","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /versions/{version_id}/publish_pre_checks","href":"/api-reference/agents/run-the-checks-a-version-must-pass-before-publishing"},{"title":"Publish an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /versions/{version_id}/publish","href":"/api-reference/agents/publish-an-agent-version"},{"title":"Get latest publish job for an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/publish/job","href":"/api-reference/agents/get-latest-publish-job-for-an-agent-version"},{"title":"List publish steps for an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/publish/steps","href":"/api-reference/agents/list-publish-steps-for-an-agent-version"},{"title":"Unpublish an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /versions/{version_id}/unpublish","href":"/api-reference/agents/unpublish-an-agent-version"},{"title":"List all jobs for an agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/jobs","href":"/api-reference/agents/list-all-jobs-for-an-agent-version"},{"title":"Wait for one validation or publish job and return its durable status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /versions/{version_id}/jobs/{job_id}/wait","href":"/api-reference/agents/wait-for-one-validation-or-publish-job-and-return-its-durable-status"}]},{"group":"Sessions","pages":[{"title":"Get a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}","href":"/api-reference/sessions/get-a-session"},{"title":"List session events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}/events","href":"/api-reference/sessions/list-session-events"},{"title":"Send a message to a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /sessions/{session_id}/events","href":"/api-reference/sessions/send-a-message-to-a-session"},{"title":"List session tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}/tasks","href":"/api-reference/sessions/list-session-tasks"},{"title":"List the runtimes a session's tasks ran on","description":"Requires `workspaces:read`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}/runtimes","href":"/api-reference/sessions/list-the-runtimes-a-sessions-tasks-ran-on"},{"title":"Observe the root task after a send-time session event watermark","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /sessions/{session_id}/wait","href":"/api-reference/sessions/observe-the-root-task-after-a-send-time-session-event-watermark"}]},{"group":"Skills","pages":[{"title":"Get a skill","description":"Requires `skills:read`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /skills/{skill_id_or_name}","href":"/api-reference/skills/get-a-skill"},{"title":"Create a skill version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /skills/{skill_id_or_name}/versions","href":"/api-reference/skills/create-a-skill-version"}]},{"group":"Integrations","pages":[{"title":"List the tools an integration provides","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /integrations/{integration_id_or_name}/tools","href":"/api-reference/integrations/list-the-tools-an-integration-provides"}]},{"group":"Accounts","pages":[{"title":"Get the identity of the calling credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /me","href":"/api-reference/accounts/get-the-identity-of-the-calling-credential"},{"title":"List an account's workspaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/workspaces","href":"/api-reference/accounts/list-an-accounts-workspaces"},{"title":"List an account's skills","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/skills","href":"/api-reference/accounts/list-an-accounts-skills"},{"title":"Create a skill owned by an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /accounts/{account_id_or_name}/skills","href":"/api-reference/accounts/create-a-skill-owned-by-an-account"},{"title":"List an account's integration credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/credentials","href":"/api-reference/accounts/list-an-accounts-integration-credentials"},{"title":"List an account's budgets joined with their priced current-cycle spend","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/budgets","href":"/api-reference/accounts/list-an-accounts-budgets-joined-with-their-priced-current-cycle-spend"},{"title":"Account KPI strip + breakdowns + time series for the Usage page","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/usage/summary","href":"/api-reference/accounts/account-kpi-strip-+-breakdowns-+-time-series-for-the-usage-page"},{"title":"One page of a breakdown (workspaces, agents, users, triggers, platforms, providers, models), sliced from the same cached aggregate as ``/usage/summary``","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /accounts/{account_id_or_name}/usage/breakdown/{dimension}","href":"/api-reference/accounts/one-page-of-a-breakdown-workspaces-agents-users-triggers-platforms-providers-models-sliced-from-the-same-cached-aggregate-as-``usagesummary``"}]},{"group":"Organizations and users","pages":[{"title":"List the current user's organization memberships","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /me/organizations","href":"/api-reference/accounts/list-the-current-users-organization-memberships"},{"title":"List organization invitations sent to the current user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /me/invitations","href":"/api-reference/accounts/list-organization-invitations-sent-to-the-current-user"},{"title":"List organization invitations sent to the current user's email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /me/email-invitations","href":"/api-reference/accounts/list-organization-invitations-sent-to-the-current-users-email"},{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /organizations/{org_id_or_name}","href":"/api-reference/accounts/get-an-organization"},{"title":"List an organization's members as users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /organizations/{org_id_or_name}/members","href":"/api-reference/accounts/list-an-organizations-members-as-users"},{"title":"List an organization's memberships","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /organizations/{org_id_or_name}/memberships","href":"/api-reference/accounts/list-an-organizations-memberships"},{"title":"List an organization's invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /organizations/{org_id_or_name}/invitations","href":"/api-reference/accounts/list-an-organizations-invitations"},{"title":"Get a user by id or handle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /users/{user_id_or_name}","href":"/api-reference/accounts/get-a-user-by-id-or-handle"},{"title":"List a user's organization memberships, by id or handle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /users/{user_id_or_name}/organizations","href":"/api-reference/accounts/list-a-users-organization-memberships-by-id-or-handle"}]}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Examples","icon":"flask","pages":[{"title":"Examples","href":"/examples/overview"}]}]},"basePath":"","title":"Observe the root task after a send-time session event watermark - Guild","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-BAvA99GL.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}