{ "contractVersion": "v1", "schemaVersion": 1, "operationRegistryVersion": 3, "runtimeOperationRegistryVersion": 5, "sourceDigest": "8c57c4929bc859d307490158a857edaeaf7499fc94565a91196b3a771183c09c", "examples": { "operations": { "searchConstructPackages": { "response": { "results": [ { "name": "slack", "orgSlug": null, "displayName": "Slack", "summary": "Read and send Slack messages.", "family": "code-plugin", "visibility": "catalog", "fulfillment": "free", "packaging": "native", "pendingApproval": false, "ref": "slack", "official": true, "publisher": { "handle": "neotask", "displayName": "Neotask", "kind": "neotask", "official": true, "verified": true }, "iconUrl": "", "categories": [ "communication" ], "channels": { "stable": { "version": "1.4.0", "releaseSeq": 7, "publishedAt": "2026-09-20T12:00:00.000Z" }, "beta": null }, "stats": { "installs30d": 0, "downloads": 0, "stars": 0 }, "provenance": "attested", "updatedAt": "2026-09-20T12:00:00.000Z", "includedWith": [] } ], "nextCursor": null, "sort": "relevance" } }, "getConstructPackage": { "response": { "package": { "name": "slack", "orgSlug": null, "displayName": "Slack", "summary": "Read and send Slack messages.", "family": "code-plugin", "visibility": "catalog", "fulfillment": "free", "packaging": "native", "pendingApproval": false, "ref": "slack", "official": true, "publisher": { "handle": "neotask", "displayName": "Neotask", "kind": "neotask", "official": true, "verified": true }, "iconUrl": "", "categories": [ "communication" ], "channels": { "stable": { "version": "1.4.0", "releaseSeq": 7, "publishedAt": "2026-09-20T12:00:00.000Z" }, "beta": null }, "stats": { "installs30d": 0, "downloads": 0, "stars": 0 }, "provenance": "attested", "updatedAt": "2026-09-20T12:00:00.000Z", "includedWith": [], "description": "Read channels and send messages from agents.", "links": { "source": "https://github.com/NeotaskInc/neotask-gateway" }, "license": "MIT", "heads": { "stable": { "version": "1.4.0", "releaseSeq": 7, "channel": "stable", "state": "installable", "publishedAt": "2026-09-20T12:00:00.000Z", "changelog": "Adds thread replies.", "compatibility": { "pluginApiRange": ">=2026.9.0", "minGatewayVersion": "2026.9.0", "builtWithVersion": "2026.9.20" }, "targets": [ { "key": "universal", "artifactSize": 48213, "artifactSha256": "9f2c6a1e0b7d4c3a8e5f1b2d6c9a0e7f3b4d5c6a7e8f9a0b1c2d3e4f5a6b7c8d" } ], "provenance": "attested", "scan": { "state": "clean" }, "manifestVersions": [ 1, 2 ], "moderation": { "state": "none" } }, "beta": null }, "docs": [], "install": { "cli": "neotask construct install slack", "cliBeta": null, "requiresSignIn": true, "desktopDeepLink": null }, "latestVersion": "1.4.0", "movedTo": null, "showcase": "## What You Can Do\n- **Catch up on channels** - Read recent messages in the channels your workspace allows.\n- **Send updates** - Post messages and thread replies on your behalf.\n- **Find past conversations** - Search message history by keyword, person or date.\n\n## Try Asking\n- \"Summarize what happened in the product channel today.\"\n- \"Post the release notes to the announcements channel.\"\n\n## Pro Tips\n- Connect Slack once and every agent in your account can use it.", "readme": "# Slack\n\nRead and send Slack messages from Neotask agents.\n\n## Install\n\n```bash\nneotask construct install slack\n```\n\n## Configure\n\nConnect your Slack workspace from Integrations, then choose the channels agents may use.", "entitlement": { "entitled": true, "source": "free_catalog", "channels": [ "beta", "stable" ], "expiresAt": "2026-09-28T18:00:00.000Z" }, "viewer": { "starred": false, "canPublish": false, "canApprove": false } } } }, "listConstructPackageVersions": { "response": { "items": [ { "version": "1.4.0", "releaseSeq": 7, "channel": "stable", "state": "installable", "publishedAt": "2026-09-20T12:00:00.000Z", "changelog": "Adds thread replies.", "compatibility": { "pluginApiRange": ">=2026.9.0", "minGatewayVersion": "2026.9.0", "builtWithVersion": "2026.9.20" }, "targets": [ { "key": "universal", "artifactSize": 48213, "artifactSha256": "9f2c6a1e0b7d4c3a8e5f1b2d6c9a0e7f3b4d5c6a7e8f9a0b1c2d3e4f5a6b7c8d" } ], "provenance": "attested", "scan": { "state": "clean" }, "manifestVersions": [ 1, 2 ], "moderation": { "state": "none" } } ], "nextCursor": null } }, "getConstructReleaseReadiness": { "response": { "package": "slack", "version": "1.4.0", "channel": "stable", "ready": true, "evaluatedAt": "2026-09-28T12:00:00.000Z", "checks": [ { "id": "scan", "status": "pass" }, { "id": "signatures", "status": "pass" } ] } }, "matchConstructContent": { "request": { "contentSha256": "3c1d9e7a5b2f4c8e0a6d1b3f5e7c9a2d4f6b8e0c1a3d5f7b9e2c4a6d8f0b1e3c", "fileCount": 12 }, "response": { "match": { "version": "1.4.0", "releaseSeq": 7, "channel": "stable" } } }, "resolveConstructArtifact": { "response": { "package": { "name": "slack", "orgSlug": null, "displayName": "Slack", "family": "code-plugin" }, "version": { "publishState": "published", "version": "1.4.0", "releaseSeq": 7, "artifactSha256": "9f2c6a1e0b7d4c3a8e5f1b2d6c9a0e7f3b4d5c6a7e8f9a0b1c2d3e4f5a6b7c8d", "artifactSize": 48213, "artifactFormat": "ntpkg", "signature": "bm90LWEtcmVhbC1zaWduYXR1cmU", "signatureKeyId": "release-2026-06", "capabilityManifest": {}, "channel": "stable", "target": { "key": "universal", "os": "any", "arch": "any", "libc": "any" } }, "download": { "url": "https://example.test/construct/slack-1.4.0.ntpkg", "expiresInSeconds": 60 }, "resolution": { "mode": "install", "channel": "stable", "hostTarget": "darwin-arm64", "targetKey": "universal", "manifestVersion": 2, "floorReleaseSeq": 0, "rollbackAuthorizedBy": null, "grantSource": "free_catalog" }, "installed": null } }, "getConstructGrantManifest": { "response": { "format": "NEOTASK-CONSTRUCT-GRANTS-V1", "manifest": { "domain": "NEOTASK-CONSTRUCT-GRANTS-V1", "issuer": "https://neotask.ai", "audience": "neotask-gateway", "tenantId": "665f0c2a9b1e4d0012ab34cd", "installationId": "Q2xpSW5zdGFsbGF0aW9uMQ", "issuedAt": 1759060800000, "expiresAt": 1759082400000, "grants": [ { "pluginId": "slack", "versionRange": "*", "channels": [ "beta", "stable" ], "notBefore": 1759060800000, "expiresAt": 1759082400000, "artifactSha256": "", "minReleaseSeq": 0, "source": "free_catalog", "blockedReleases": [] } ] }, "signatures": [ { "keyId": "grants-2026-09", "algorithm": "Ed25519", "signature": "bm90LWEtcmVhbC1zaWduYXR1cmU" } ] } }, "reportConstructInstall": { "request": { "package": "slack", "version": "1.4.0", "releaseSeq": 7, "targetKey": "universal", "channel": "stable", "event": "install", "installationId": "Q2xpSW5zdGFsbGF0aW9uMQ", "source": "cli", "gatewayVersion": "2026.9.28" }, "response": { "accepted": true, "deduplicated": false } }, "reportConstructPackage": { "request": { "package": "slack", "version": "1.4.0", "reason": "broken", "details": "Sending fails with a timeout after the update." }, "response": { "report": { "reportId": "rpt_0123456789abcdef0123456789abcdef", "package": "slack", "version": "1.4.0", "reason": "broken", "state": "open", "outcome": null, "createdAt": "2026-09-28T12:00:00.000Z", "updatedAt": "2026-09-28T12:00:00.000Z" } } }, "listInsightBoards": { "response": { "boards": [], "nextCursor": null } }, "getInsightBoard": { "response": { "board": { "boardId": "board_example", "scopeType": "company", "scopeId": "company_example", "title": "Board", "publication": { "visibility": "private_owner", "state": "unpublished", "generation": 0 } } } }, "getInsightBoardPublication": { "response": { "publication": { "visibility": "private_owner", "state": "unpublished", "generation": 0 }, "link": null, "grants": { "active": 0 }, "lastJob": null, "viewerOrigin": "https://neotask.ai", "viewerPath": null } }, "publishInsightBoard": { "request": { "visibility": "email_list" }, "response": { "replayed": false, "jobId": "job_example", "publication": { "visibility": "private_owner", "state": "unpublished", "generation": 0 } } }, "unpublishInsightBoard": { "request": {}, "response": { "replayed": false, "jobId": "job_example", "publication": { "visibility": "private_owner", "state": "unpublished", "generation": 0 } } }, "rotateInsightBoardLink": { "request": {}, "response": { "replayed": false, "jobId": "job_example", "publication": { "visibility": "private_owner", "state": "unpublished", "generation": 0 } } }, "setInsightBoardVisibility": { "request": { "visibility": "email_list" }, "response": { "replayed": false, "jobId": "job_example", "publication": { "visibility": "private_owner", "state": "unpublished", "generation": 0 } } }, "listInsightBoardGrants": { "response": { "grants": [] } }, "createInsightBoardGrant": { "request": { "granteeType": "email", "granteeEmail": "viewer@example.test" }, "response": { "replayed": false, "jobId": "job_example", "grant": { "grantId": "grant_example", "boardId": "board_example", "accessLevel": "viewer" } } }, "revokeInsightBoardGrant": { "request": {}, "response": { "replayed": false, "jobId": "job_example", "grant": { "grantId": "grant_example", "boardId": "board_example", "accessLevel": "viewer" } } }, "listAgentCompanies": { "response": { "companies": [ { "companyRef": "company_example", "name": "Example studio", "description": "Company work", "timezone": "UTC", "status": "active", "createdAt": null, "updatedAt": null } ], "nextCursor": null } }, "getAgentCompany": { "response": { "company": { "companyRef": "company_example", "name": "Example studio", "description": "Company work", "timezone": "UTC", "status": "active", "createdAt": null, "updatedAt": null }, "agentCount": 0, "runsByState": { "completed": 1 }, "heartbeat": { "status": "unknown", "lastCompletedAt": null, "nextPlannedAt": null }, "readOnly": true } }, "listAgentCompanyAgents": { "response": { "companyRef": "company_example", "agents": [], "nextCursor": null } }, "listAgentCompanyTasks": { "response": { "companyRef": "company_example", "tasks": [ { "taskRef": "task_eyJ2IjoxLCJzb3VyY2UiOiJwbGFuIiwicGFyZW50IjoiNTA3ZjFmNzdiY2Y4NmNkNzk5NDM5MDExIiwiaWQiOiJ3ZWVrbHlfcmV2aWV3In0", "id": "weekly_review", "companyRef": "company_example", "source": "plan", "parentRef": "plan_example", "parentStatus": "approved", "name": "Weekly review", "description": null, "instruction": "Review the work completed this week.", "status": "active", "enabled": true, "agentId": null, "model": null, "scheduleCron": null, "scheduleTimezone": null, "nextRunAt": null, "latestRunId": null, "executionTaskId": "weekly_review", "gateState": null, "createdAt": null, "updatedAt": null } ], "nextCursor": null } }, "getAgentCompanyTask": { "response": { "task": { "taskRef": "task_eyJ2IjoxLCJzb3VyY2UiOiJwbGFuIiwicGFyZW50IjoiNTA3ZjFmNzdiY2Y4NmNkNzk5NDM5MDExIiwiaWQiOiJ3ZWVrbHlfcmV2aWV3In0", "id": "weekly_review", "companyRef": "company_example", "source": "plan", "parentRef": "plan_example", "parentStatus": "approved", "name": "Weekly review", "description": null, "instruction": "Review the work completed this week.", "status": "active", "enabled": true, "agentId": null, "model": null, "scheduleCron": null, "scheduleTimezone": null, "nextRunAt": null, "latestRunId": null, "executionTaskId": "weekly_review", "gateState": null, "createdAt": null, "updatedAt": null } } }, "listAgentCompanyRuns": { "response": { "companyRef": "company_example", "runs": [ { "id": "run_example", "companyRef": "company_example", "taskId": "weekly_review", "status": "completed", "stateSeq": 3, "terminal": true, "terminalReason": null, "lastStepLabel": "Review complete", "startedAt": null, "terminalAt": null, "updatedAt": null, "retryAtMs": null, "retryReason": null, "outcome": { "title": "Weekly review", "value": "The review is complete." } } ], "nextCursor": null } }, "getAgentCompanyRun": { "response": { "run": { "id": "run_example", "companyRef": "company_example", "taskId": "weekly_review", "status": "completed", "stateSeq": 3, "terminal": true, "terminalReason": null, "lastStepLabel": "Review complete", "startedAt": null, "terminalAt": null, "updatedAt": null, "retryAtMs": null, "retryReason": null, "outcome": { "title": "Weekly review", "value": "The review is complete." } } } }, "getAgentProfile": { "response": { "schemaVersion": 3, "principal": { "registrationId": "reg_example", "identityMode": "anonymous", "trustLevel": "untrusted", "authorityPhase": "pre_claim", "role": "agent", "credential": { "issuedAt": 1787875200, "expiresAt": 1787875800 } }, "account": { "tenantId": "tenant_example", "userId": "user_example", "name": "Agent trial account", "status": "active", "keyMode": "managed" }, "plan": { "id": "free", "displayName": "Free", "features": [], "limits": { "maxAgents": null, "maxChannels": 1, "maxDevices": 1, "maxRequestsPerMinute": 60, "maxPromptBytes": 524288, "messageLimit": 10, "usedMessages": 0, "remainingMessages": 10, "historyDays": 7, "maxCompanies": 0 }, "models": { "tier": "basic", "allowed": [ "neotask/neotask-matrix" ] } }, "capabilitiesUrl": "/api/agent/v1/capabilities" } }, "getAgentCapabilities": { "response": { "schemaVersion": 3, "operationRegistryVersion": 5, "principal": { "registrationId": "reg_example", "identityMode": "anonymous", "trustLevel": "untrusted", "authorityPhase": "pre_claim", "role": "agent", "credential": { "issuedAt": 1787875200, "expiresAt": 1787875800 } }, "account": { "tenantId": "tenant_example", "userId": "user_example", "name": "Agent trial account", "status": "active", "keyMode": "managed" }, "plan": { "id": "free", "displayName": "Free", "features": [], "limits": { "maxAgents": null, "maxChannels": 1, "maxDevices": 1, "maxRequestsPerMinute": 60, "maxPromptBytes": 524288, "messageLimit": 10, "usedMessages": 0, "remainingMessages": 10, "historyDays": 7, "maxCompanies": 0 }, "models": { "tier": "basic", "allowed": [ "neotask/neotask-matrix" ] } }, "capabilities": { "accountClaim": { "availability": "claim_required", "available": false, "reason": "verified_user_claim_required" }, "profileRead": { "availability": "available", "available": true, "reason": null, "requiredScope": "neotask:profile:read" }, "catalogRead": { "availability": "available", "available": true, "reason": null, "requiredScope": "neotask:catalog:read" }, "generalApiAccess": { "availability": "available", "available": true, "reason": null }, "companyAccess": { "availability": "plan_required", "available": false, "reason": "plan_feature_required", "requiredFeature": "auto_companies", "upgrade": { "required": true, "checkoutUrl": null } }, "coding": { "availability": "available", "available": true, "reason": null }, "messageUsage": { "availability": "available", "available": true, "reason": null } }, "execution": { "recommendedMode": "local_runner", "modes": [ { "id": "local_runner", "availability": "setup_required", "reason": "runner_not_enrolled", "setupUrl": "https://neotask.ai/agent-onboarding#local-runner" }, { "id": "cloud_runner", "availability": "temporarily_disabled", "reason": "cloud_runner_not_connected" } ] }, "operations": [ { "operationId": "listAgentCompanies", "method": "GET", "path": "/api/agent/v1/companies", "requiredScope": "neotask:companies:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getAgentCompany", "method": "GET", "path": "/api/agent/v1/companies/{companyRef}", "requiredScope": "neotask:companies:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "listAgentCompanyAgents", "method": "GET", "path": "/api/agent/v1/companies/{companyRef}/agents", "requiredScope": "neotask:companies:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "listAgentCompanyTasks", "method": "GET", "path": "/api/agent/v1/companies/{companyRef}/tasks", "requiredScope": "neotask:companies:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getAgentCompanyTask", "method": "GET", "path": "/api/agent/v1/companies/{companyRef}/tasks/{taskRef}", "requiredScope": "neotask:companies:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "listAgentCompanyRuns", "method": "GET", "path": "/api/agent/v1/companies/{companyRef}/runs", "requiredScope": "neotask:companies:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getAgentCompanyRun", "method": "GET", "path": "/api/agent/v1/companies/{companyRef}/runs/{runRef}", "requiredScope": "neotask:companies:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "listInsightBoards", "method": "GET", "path": "/api/agent/v1/boards", "requiredScope": "neotask:boards:read", "scopeGranted": false, "availability": "temporarily_disabled", "reason": "board_publishing_disabled", "idempotencyRequired": false }, { "operationId": "getInsightBoard", "method": "GET", "path": "/api/agent/v1/boards/{boardId}", "requiredScope": "neotask:boards:read", "scopeGranted": false, "availability": "temporarily_disabled", "reason": "board_publishing_disabled", "idempotencyRequired": false }, { "operationId": "getInsightBoardPublication", "method": "GET", "path": "/api/agent/v1/boards/{boardId}/publication", "requiredScope": "neotask:boards:read", "scopeGranted": false, "availability": "temporarily_disabled", "reason": "board_publishing_disabled", "idempotencyRequired": false }, { "operationId": "publishInsightBoard", "method": "POST", "path": "/api/agent/v1/boards/{boardId}/publish", "requiredScope": "neotask:boards:publish", "scopeGranted": false, "availability": "temporarily_disabled", "reason": "board_publishing_disabled", "idempotencyRequired": true }, { "operationId": "unpublishInsightBoard", "method": "POST", "path": "/api/agent/v1/boards/{boardId}/unpublish", "requiredScope": "neotask:boards:publish", "scopeGranted": false, "availability": "temporarily_disabled", "reason": "board_publishing_disabled", "idempotencyRequired": true }, { "operationId": "rotateInsightBoardLink", "method": "POST", "path": "/api/agent/v1/boards/{boardId}/rotate-link", "requiredScope": "neotask:boards:publish", "scopeGranted": false, "availability": "temporarily_disabled", "reason": "board_publishing_disabled", "idempotencyRequired": true }, { "operationId": "setInsightBoardVisibility", "method": "PUT", "path": "/api/agent/v1/boards/{boardId}/visibility", "requiredScope": "neotask:boards:share", "scopeGranted": false, "availability": "temporarily_disabled", "reason": "board_publishing_disabled", "idempotencyRequired": true }, { "operationId": "listInsightBoardGrants", "method": "GET", "path": "/api/agent/v1/boards/{boardId}/grants", "requiredScope": "neotask:boards:share", "scopeGranted": false, "availability": "temporarily_disabled", "reason": "board_publishing_disabled", "idempotencyRequired": false }, { "operationId": "createInsightBoardGrant", "method": "POST", "path": "/api/agent/v1/boards/{boardId}/grants", "requiredScope": "neotask:boards:share", "scopeGranted": false, "availability": "temporarily_disabled", "reason": "board_publishing_disabled", "idempotencyRequired": true }, { "operationId": "revokeInsightBoardGrant", "method": "DELETE", "path": "/api/agent/v1/boards/{boardId}/grants/{grantId}", "requiredScope": "neotask:boards:share", "scopeGranted": false, "availability": "temporarily_disabled", "reason": "board_publishing_disabled", "idempotencyRequired": true }, { "operationId": "getAgentProfile", "method": "GET", "path": "/api/agent/v1/me", "requiredScope": "neotask:profile:read", "scopeGranted": true, "availability": "available", "reason": null, "idempotencyRequired": false }, { "operationId": "getAgentCapabilities", "method": "GET", "path": "/api/agent/v1/capabilities", "requiredScope": "neotask:catalog:read", "scopeGranted": true, "availability": "available", "reason": null, "idempotencyRequired": false }, { "operationId": "getAgentOnboarding", "method": "GET", "path": "/api/agent/v1/onboarding", "requiredScope": "neotask:catalog:read", "scopeGranted": true, "availability": "available", "reason": null, "idempotencyRequired": false }, { "operationId": "listAgents", "method": "GET", "path": "/api/agent/v1/agents", "requiredScope": "neotask:agents:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "createAgent", "method": "POST", "path": "/api/agent/v1/agents", "requiredScope": "neotask:agents:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgent", "method": "GET", "path": "/api/agent/v1/agents/{agentRef}", "requiredScope": "neotask:agents:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "updateAgent", "method": "PATCH", "path": "/api/agent/v1/agents/{agentRef}", "requiredScope": "neotask:agents:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "archiveAgent", "method": "POST", "path": "/api/agent/v1/agents/{agentRef}/archive", "requiredScope": "neotask:agents:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "restoreAgent", "method": "POST", "path": "/api/agent/v1/agents/{agentRef}/restore", "requiredScope": "neotask:agents:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentEffectiveTools", "method": "GET", "path": "/api/agent/v1/agents/{agentRef}/tools", "requiredScope": "neotask:catalog:read", "scopeGranted": true, "availability": "available", "reason": null, "idempotencyRequired": false }, { "operationId": "getAgentToolPolicy", "method": "GET", "path": "/api/agent/v1/agents/{agentRef}/tool-policy", "requiredScope": "neotask:agents:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "updateAgentToolPolicy", "method": "PATCH", "path": "/api/agent/v1/agents/{agentRef}/tool-policy", "requiredScope": "neotask:agents:configure", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentConversations", "method": "GET", "path": "/api/agent/v1/conversations", "requiredScope": "neotask:conversations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "createAgentConversation", "method": "POST", "path": "/api/agent/v1/conversations", "requiredScope": "neotask:conversations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentConversation", "method": "GET", "path": "/api/agent/v1/conversations/{conversationRef}", "requiredScope": "neotask:conversations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "archiveAgentConversation", "method": "POST", "path": "/api/agent/v1/conversations/{conversationRef}/archive", "requiredScope": "neotask:conversations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "restoreAgentConversation", "method": "POST", "path": "/api/agent/v1/conversations/{conversationRef}/restore", "requiredScope": "neotask:conversations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentConversationMessages", "method": "GET", "path": "/api/agent/v1/conversations/{conversationRef}/messages", "requiredScope": "neotask:conversations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "createAgentConversationTurn", "method": "POST", "path": "/api/agent/v1/conversations/{conversationRef}/turns", "requiredScope": "neotask:conversations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentConversationTurn", "method": "GET", "path": "/api/agent/v1/conversations/{conversationRef}/turns/{turnRef}", "requiredScope": "neotask:conversations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "cancelAgentConversationTurn", "method": "POST", "path": "/api/agent/v1/conversations/{conversationRef}/turns/{turnRef}/cancel", "requiredScope": "neotask:conversations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentConversationTurnEvents", "method": "GET", "path": "/api/agent/v1/conversations/{conversationRef}/turns/{turnRef}/events", "requiredScope": "neotask:conversations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "streamAgentConversationTurnEvents", "method": "GET", "path": "/api/agent/v1/conversations/{conversationRef}/turns/{turnRef}/events/stream", "requiredScope": "neotask:conversations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "listTasks", "method": "GET", "path": "/api/agent/v1/tasks", "requiredScope": "neotask:tasks:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "createTask", "method": "POST", "path": "/api/agent/v1/tasks", "requiredScope": "neotask:tasks:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentCronJobs", "method": "GET", "path": "/api/agent/v1/automations/cron", "requiredScope": "neotask:cron:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "createAgentCronJob", "method": "POST", "path": "/api/agent/v1/automations/cron", "requiredScope": "neotask:cron:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentCronJob", "method": "GET", "path": "/api/agent/v1/automations/cron/{cronJobRef}", "requiredScope": "neotask:cron:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "updateAgentCronJob", "method": "PATCH", "path": "/api/agent/v1/automations/cron/{cronJobRef}", "requiredScope": "neotask:cron:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "enableAgentCronJob", "method": "POST", "path": "/api/agent/v1/automations/cron/{cronJobRef}/enable", "requiredScope": "neotask:cron:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "disableAgentCronJob", "method": "POST", "path": "/api/agent/v1/automations/cron/{cronJobRef}/disable", "requiredScope": "neotask:cron:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "runAgentCronJob", "method": "POST", "path": "/api/agent/v1/automations/cron/{cronJobRef}/runs", "requiredScope": "neotask:cron:run", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentCronJobRuns", "method": "GET", "path": "/api/agent/v1/automations/cron/{cronJobRef}/runs", "requiredScope": "neotask:cron:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "deleteAgentCronJob", "method": "DELETE", "path": "/api/agent/v1/automations/cron/{cronJobRef}", "requiredScope": "neotask:cron:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentAutomationCatalog", "method": "GET", "path": "/api/agent/v1/automations/flows/catalog", "requiredScope": "neotask:automations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "listAgentAutomations", "method": "GET", "path": "/api/agent/v1/automations/flows", "requiredScope": "neotask:automations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "createAgentAutomation", "method": "POST", "path": "/api/agent/v1/automations/flows", "requiredScope": "neotask:automations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentAutomation", "method": "GET", "path": "/api/agent/v1/automations/flows/{automationRef}", "requiredScope": "neotask:automations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "updateAgentAutomation", "method": "PATCH", "path": "/api/agent/v1/automations/flows/{automationRef}", "requiredScope": "neotask:automations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "deleteAgentAutomation", "method": "DELETE", "path": "/api/agent/v1/automations/flows/{automationRef}", "requiredScope": "neotask:automations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "startAgentAutomation", "method": "POST", "path": "/api/agent/v1/automations/flows/{automationRef}/start", "requiredScope": "neotask:automations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentAutomationStatus", "method": "GET", "path": "/api/agent/v1/automations/flows/{automationRef}/status", "requiredScope": "neotask:automations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "pauseAgentAutomation", "method": "POST", "path": "/api/agent/v1/automations/flows/{automationRef}/pause", "requiredScope": "neotask:automations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "resumeAgentAutomation", "method": "POST", "path": "/api/agent/v1/automations/flows/{automationRef}/resume", "requiredScope": "neotask:automations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "cancelAgentAutomation", "method": "POST", "path": "/api/agent/v1/automations/flows/{automationRef}/cancel", "requiredScope": "neotask:automations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentAutomationRuns", "method": "GET", "path": "/api/agent/v1/automations/flows/{automationRef}/runs", "requiredScope": "neotask:automations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getRun", "method": "GET", "path": "/api/agent/v1/runs/{runId}", "requiredScope": "neotask:runs:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "createRun", "method": "POST", "path": "/api/agent/v1/runs", "requiredScope": "neotask:runs:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentRunEvents", "method": "GET", "path": "/api/agent/v1/runs/{runRef}/events", "requiredScope": "neotask:runs:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "streamAgentRunEvents", "method": "GET", "path": "/api/agent/v1/runs/{runRef}/events/stream", "requiredScope": "neotask:runs:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "listAgentAutonomyGoals", "method": "GET", "path": "/api/agent/v1/autonomy/goals", "requiredScope": "neotask:autonomy:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "createAgentAutonomyGoal", "method": "POST", "path": "/api/agent/v1/autonomy/goals", "requiredScope": "neotask:autonomy:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentAutonomyGoal", "method": "GET", "path": "/api/agent/v1/autonomy/goals/{goalRef}", "requiredScope": "neotask:autonomy:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "updateAgentAutonomyGoal", "method": "PATCH", "path": "/api/agent/v1/autonomy/goals/{goalRef}", "requiredScope": "neotask:autonomy:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "startAgentAutonomyGoal", "method": "POST", "path": "/api/agent/v1/autonomy/goals/{goalRef}/start", "requiredScope": "neotask:autonomy:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentAutonomyGoalStatus", "method": "GET", "path": "/api/agent/v1/autonomy/goals/{goalRef}/status", "requiredScope": "neotask:autonomy:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "steerAgentAutonomyGoal", "method": "POST", "path": "/api/agent/v1/autonomy/goals/{goalRef}/steer", "requiredScope": "neotask:autonomy:steer", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "pauseAgentAutonomyGoal", "method": "POST", "path": "/api/agent/v1/autonomy/goals/{goalRef}/pause", "requiredScope": "neotask:autonomy:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "resumeAgentAutonomyGoal", "method": "POST", "path": "/api/agent/v1/autonomy/goals/{goalRef}/resume", "requiredScope": "neotask:autonomy:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "cancelAgentAutonomyGoal", "method": "POST", "path": "/api/agent/v1/autonomy/goals/{goalRef}/cancel", "requiredScope": "neotask:autonomy:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentAutonomyGoalRuns", "method": "GET", "path": "/api/agent/v1/autonomy/goals/{goalRef}/runs", "requiredScope": "neotask:autonomy:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "listAgentApprovals", "method": "GET", "path": "/api/agent/v1/approvals", "requiredScope": "neotask:approvals:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getAgentApproval", "method": "GET", "path": "/api/agent/v1/approvals/{approvalRef}", "requiredScope": "neotask:approvals:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "createAgentApprovalHandoff", "method": "POST", "path": "/api/agent/v1/approvals/{approvalRef}/human-handoffs", "requiredScope": "neotask:approvals:handoff", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentApprovalHandoff", "method": "GET", "path": "/api/agent/v1/approvals/{approvalRef}/human-handoffs/{handoffRef}", "requiredScope": "neotask:approvals:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "cancelAgentApprovalHandoff", "method": "POST", "path": "/api/agent/v1/approvals/{approvalRef}/human-handoffs/{handoffRef}/cancel", "requiredScope": "neotask:approvals:handoff", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentApprovalEvents", "method": "GET", "path": "/api/agent/v1/approvals/{approvalRef}/events", "requiredScope": "neotask:approvals:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "streamAgentApprovalEvents", "method": "GET", "path": "/api/agent/v1/approvals/{approvalRef}/events/stream", "requiredScope": "neotask:approvals:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getEffectiveAgentApprovalPolicy", "method": "GET", "path": "/api/agent/v1/agents/{agentRef}/approval-policy", "requiredScope": "neotask:approvals:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "createAgentApprovalSettingsHandoff", "method": "POST", "path": "/api/agent/v1/agents/{agentRef}/approval-settings-handoffs", "requiredScope": "neotask:approvals:handoff", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentApprovalSettingsHandoff", "method": "GET", "path": "/api/agent/v1/agents/{agentRef}/approval-settings-handoffs/{handoffRef}", "requiredScope": "neotask:approvals:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "cancelAgentApprovalSettingsHandoff", "method": "POST", "path": "/api/agent/v1/agents/{agentRef}/approval-settings-handoffs/{handoffRef}/cancel", "requiredScope": "neotask:approvals:handoff", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "decideAgentApproval", "method": "POST", "path": "/api/agent/v1/approvals/{approvalRef}/decisions", "requiredScope": "neotask:approvals:decide", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getUsage", "method": "GET", "path": "/api/agent/v1/usage", "requiredScope": "neotask:usage:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "listAgentSkills", "method": "GET", "path": "/api/agent/v1/skills", "requiredScope": "neotask:catalog:read", "scopeGranted": true, "availability": "available", "reason": null, "idempotencyRequired": false }, { "operationId": "listDesktopDownloadOptions", "method": "GET", "path": "/api/agent/v1/desktop/downloads", "requiredScope": "neotask:catalog:read", "scopeGranted": true, "availability": "claim_required", "reason": "human_control_required", "idempotencyRequired": false }, { "operationId": "requestAgentSkillConfiguration", "method": "POST", "path": "/api/agent/v1/skills/{skillId}/configure", "requiredScope": "neotask:skills:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentMcpCatalog", "method": "GET", "path": "/api/agent/v1/mcp/catalog", "requiredScope": "neotask:catalog:read", "scopeGranted": true, "availability": "available", "reason": null, "idempotencyRequired": false }, { "operationId": "getAgentCliMetadata", "method": "GET", "path": "/api/agent/v1/cli", "requiredScope": "neotask:catalog:read", "scopeGranted": true, "availability": "available", "reason": null, "idempotencyRequired": false }, { "operationId": "listAgentModels", "method": "GET", "path": "/api/agent/v1/models", "requiredScope": "neotask:models:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "setAgentModel", "method": "PUT", "path": "/api/agent/v1/agents/{agentRef}/model", "requiredScope": "neotask:models:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentMailCapabilities", "method": "GET", "path": "/api/agent/v1/mail/capabilities", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "requestAgentMailMembership", "method": "POST", "path": "/api/agent/v1/mail/membership-requests", "requiredScope": "neotask:mail:security", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "joinAgentMailMembership", "method": "POST", "path": "/api/agent/v1/mail/membership/join", "requiredScope": "neotask:mail:security", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentMailMembership", "method": "GET", "path": "/api/agent/v1/mail/membership", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "approveAgentMailMembership", "method": "POST", "path": "/api/agent/v1/mail/membership/{membershipId}/approve", "requiredScope": "neotask:mail:security", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "suspendAgentMailMembership", "method": "POST", "path": "/api/agent/v1/mail/membership/{membershipId}/suspend", "requiredScope": "neotask:mail:security", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "leaveAgentMailMembership", "method": "POST", "path": "/api/agent/v1/mail/membership/leave", "requiredScope": "neotask:mail:security", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "revokeAgentMailMembership", "method": "POST", "path": "/api/agent/v1/mail/membership/{membershipId}/revoke", "requiredScope": "neotask:mail:security", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentMailIdentities", "method": "GET", "path": "/api/agent/v1/mail/identities", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getAgentMailIdentity", "method": "GET", "path": "/api/agent/v1/mail/identities/self", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "listAgentMailPeers", "method": "GET", "path": "/api/agent/v1/mail/peers", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getAgentMailPeer", "method": "GET", "path": "/api/agent/v1/mail/peers/{peerId}", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "sendAgentMailMessage", "method": "POST", "path": "/api/agent/v1/mail/messages", "requiredScope": "neotask:mail:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "replyAgentMailMessage", "method": "POST", "path": "/api/agent/v1/mail/messages/{messageId}/reply", "requiredScope": "neotask:mail:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentMailInbox", "method": "GET", "path": "/api/agent/v1/mail/inbox", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getAgentMailEvents", "method": "GET", "path": "/api/agent/v1/mail/events", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getAgentMailDelivery", "method": "GET", "path": "/api/agent/v1/mail/deliveries/{messageId}", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "acknowledgeAgentMailDelivery", "method": "POST", "path": "/api/agent/v1/mail/deliveries/{messageId}/ack", "requiredScope": "neotask:mail:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "markAgentMailRead", "method": "POST", "path": "/api/agent/v1/mail/messages/{messageId}/read", "requiredScope": "neotask:mail:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "revokeAgentRegistration", "method": "DELETE", "path": "/api/agent/v1/registration", "requiredScope": "neotask:registration:revoke", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "createAgentAccountPairingHandoff", "method": "POST", "path": "/api/agent/v1/account/pairing-handoffs", "requiredScope": "neotask:account:pair", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "requestAgentCheckoutHandoff", "method": "POST", "path": "/api/agent/checkout-handoffs/request", "requiredScope": "neotask:billing:handoff", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentAccountPairingHandoff", "method": "GET", "path": "/api/agent/v1/account/pairing-handoffs/{handoffRef}", "requiredScope": "neotask:account:pair", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "cancelAgentAccountPairingHandoff", "method": "POST", "path": "/api/agent/v1/account/pairing-handoffs/{handoffRef}/cancel", "requiredScope": "neotask:account:pair", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "createRunnerEnrollment", "method": "POST", "path": "/api/agent/v1/runners", "requiredScope": "neotask:runners:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentRunners", "method": "GET", "path": "/api/agent/v1/runners", "requiredScope": "neotask:runners:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "rotateAgentRunner", "method": "POST", "path": "/api/agent/v1/runners/{runnerId}/rotate", "requiredScope": "neotask:runners:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "revokeAgentRunner", "method": "DELETE", "path": "/api/agent/v1/runners/{runnerId}", "requiredScope": "neotask:runners:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentIntegrationCatalog", "method": "GET", "path": "/api/agent/v1/integrations/catalog", "requiredScope": "neotask:catalog:read", "scopeGranted": true, "availability": "available", "reason": null, "idempotencyRequired": false }, { "operationId": "listAgentIntegrationConnections", "method": "GET", "path": "/api/agent/v1/integrations/connections", "requiredScope": "neotask:integrations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "createAgentIntegrationAttempt", "method": "POST", "path": "/api/agent/v1/integrations/attempts", "requiredScope": "neotask:integrations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentIntegrationAttempt", "method": "GET", "path": "/api/agent/v1/integrations/attempts/{attemptId}", "requiredScope": "neotask:integrations:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "cancelAgentIntegrationAttempt", "method": "POST", "path": "/api/agent/v1/integrations/attempts/{attemptId}/cancel", "requiredScope": "neotask:integrations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "attachAgentIntegration", "method": "POST", "path": "/api/agent/v1/integrations/connections/{connectionId}/attach", "requiredScope": "neotask:integrations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "detachAgentIntegration", "method": "POST", "path": "/api/agent/v1/integrations/connections/{connectionId}/detach", "requiredScope": "neotask:integrations:write", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "revokeAgentIntegration", "method": "POST", "path": "/api/agent/v1/integrations/connections/{connectionId}/revoke", "requiredScope": "neotask:integrations:security", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "getAgentMailThread", "method": "GET", "path": "/api/agent/v1/mail/threads/{threadId}", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "searchAgentMailThreads", "method": "POST", "path": "/api/agent/v1/mail/threads/search", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "summarizeAgentMailThread", "method": "POST", "path": "/api/agent/v1/mail/threads/{threadId}/summarize", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "requestAgentMailContact", "method": "POST", "path": "/api/agent/v1/mail/contacts/requests", "requiredScope": "neotask:mail:contacts", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "respondAgentMailContact", "method": "POST", "path": "/api/agent/v1/mail/contacts/{contactId}/respond", "requiredScope": "neotask:mail:contacts", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentMailContacts", "method": "GET", "path": "/api/agent/v1/mail/contacts", "requiredScope": "neotask:mail:contacts", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "setAgentMailContactPolicy", "method": "POST", "path": "/api/agent/v1/mail/contacts/policy", "requiredScope": "neotask:mail:contacts", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "listAgentMailSectors", "method": "GET", "path": "/api/agent/v1/mail/sectors", "requiredScope": "neotask:mail:sectors", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getAgentMailSectorFeed", "method": "GET", "path": "/api/agent/v1/mail/sectors/{sectorId}/feed", "requiredScope": "neotask:mail:sectors", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "broadcastAgentMailSector", "method": "POST", "path": "/api/agent/v1/mail/sectors/{sectorId}/broadcast", "requiredScope": "neotask:mail:sectors", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "announceAgentMailHandoff", "method": "POST", "path": "/api/agent/v1/mail/handoffs", "requiredScope": "neotask:mail:handoffs", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "attachAgentMailTrace", "method": "POST", "path": "/api/agent/v1/mail/handoffs/{handoffRef}/trace", "requiredScope": "neotask:mail:handoffs", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "waitForAgentMailEvents", "method": "POST", "path": "/api/agent/v1/mail/events/wait", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "recoverAgentMailEvents", "method": "POST", "path": "/api/agent/v1/mail/events/recover", "requiredScope": "neotask:mail:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "exportAgentMailData", "method": "POST", "path": "/api/agent/v1/mail/export", "requiredScope": "neotask:mail:security", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "eraseAgentMailData", "method": "POST", "path": "/api/agent/v1/mail/erase", "requiredScope": "neotask:mail:security", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "revokeAgentMailAccess", "method": "POST", "path": "/api/agent/v1/mail/access/revoke", "requiredScope": "neotask:mail:security", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "searchConstructPackages", "method": "GET", "path": "/api/agent/v1/construct/packages/search", "requiredScope": "neotask:construct:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getConstructPackage", "method": "GET", "path": "/api/agent/v1/construct/packages/{ref}", "requiredScope": "neotask:construct:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "listConstructPackageVersions", "method": "GET", "path": "/api/agent/v1/construct/packages/{ref}/versions", "requiredScope": "neotask:construct:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getConstructReleaseReadiness", "method": "GET", "path": "/api/agent/v1/construct/packages/{ref}/release-readiness", "requiredScope": "neotask:construct:read", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "matchConstructContent", "method": "POST", "path": "/api/agent/v1/construct/packages/{ref}/content-match", "requiredScope": "neotask:construct:install", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "resolveConstructArtifact", "method": "GET", "path": "/api/agent/v1/construct/resolve", "requiredScope": "neotask:construct:install", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "getConstructGrantManifest", "method": "GET", "path": "/api/agent/v1/construct/entitlements/manifest", "requiredScope": "neotask:construct:install", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": false }, { "operationId": "reportConstructInstall", "method": "POST", "path": "/api/agent/v1/construct/installs", "requiredScope": "neotask:construct:install", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true }, { "operationId": "reportConstructPackage", "method": "POST", "path": "/api/agent/v1/construct/reports", "requiredScope": "neotask:construct:feedback", "scopeGranted": false, "availability": "setup_required", "reason": "credential_scope_missing", "idempotencyRequired": true } ] } }, "getAgentOnboarding": { "response": { "schemaVersion": 1, "generatedAt": "2026-08-28T00:00:00.000Z", "operationRegistryVersion": 5, "service": { "launchState": "feature_gated", "restResource": "https://neotask.ai/api/agent", "mcpResource": "https://neotask.ai/mcp" }, "identity": { "authorityPhase": "pre_claim", "registrationMethod": "anonymous", "identityState": "agent_trial", "lifecycleState": "agent_trial", "tenantKind": "standard", "humanControl": "not_linked", "freePolicy": "ordinary", "claimRequiredFor": [ "paid", "company", "ui_pairing", "integrations", "mail", "identity_sensitive", "destructive" ], "claimAvailable": true, "claim": { "verification": "workos_uri_and_user_code_polling" } }, "execution": { "recommendedMode": "local_runner", "modes": [ { "id": "local_runner", "availability": "setup_required", "reason": "runner_not_enrolled", "setupUrl": "https://neotask.ai/agent-onboarding#local-runner" }, { "id": "cloud_runner", "availability": "temporarily_disabled", "reason": "cloud_runner_not_connected" } ] }, "progress": { "state": "agent_needed", "completedMilestones": [ "identity_authenticated", "account_materialized" ], "successDefinition": "first_successful_run", "nextOperationId": "createAgent" }, "nextActions": [ { "stepId": "create-first-agent", "operationId": "createAgent", "scopeGranted": true, "availability": "available", "reason": null, "idempotencyRequired": true, "documentationUrl": "https://neotask.ai/docs/api/create-agent.md" } ], "blockers": [], "humanActions": [], "resources": { "agents": { "count": 0, "truncated": false, "activeCount": 0 }, "tasks": { "count": 0, "truncated": false, "activeCount": 0 }, "runs": { "count": 0, "truncated": false, "successfulCount": 0, "inProgressCount": 0 }, "runners": { "count": 0, "truncated": false, "enrolledCount": 0, "connectedCount": 0 }, "integrationAttempts": { "count": 0, "truncated": false, "activeCount": 0 }, "integrationConnections": { "count": 0, "truncated": false, "activeCount": 0 }, "skills": { "count": 0, "truncated": false, "publishedCount": 0 }, "models": { "count": 0, "truncated": false, "availableCount": 0 }, "effectiveTools": { "count": 0, "truncated": false, "availableCount": 0 }, "conversations": { "count": 0, "truncated": false, "activeCount": 0 }, "turns": { "count": 0, "truncated": false, "inProgressCount": 0 }, "cron": { "count": 0, "truncated": false, "enabledCount": 0 }, "automations": { "count": 0, "truncated": false, "activeCount": 0 }, "autonomyGoals": { "count": 0, "truncated": false, "activeCount": 0 }, "approvals": { "count": 0, "truncated": false, "pendingCount": 0 }, "coordinationMail": { "count": 0, "truncated": false, "activeCount": 0 }, "pairing": { "state": "not_requested" } } } }, "listAgents": { "response": { "agents": [], "nextCursor": null } }, "createAgent": { "request": { "name": "Research helper" }, "response": { "agent": { "id": "agent_example", "name": "Research helper", "scopeType": "standalone", "createdAt": null, "updatedAt": null } } }, "getAgent": { "response": { "agent": { "id": "agent_example", "name": "Research helper", "scopeType": "standalone", "lifecycleState": "active", "createdAt": null, "updatedAt": null } } }, "updateAgent": { "request": { "name": "Research helper" }, "response": { "agent": { "id": "agent_example", "name": "Research helper", "scopeType": "standalone", "lifecycleState": "active", "createdAt": null, "updatedAt": null } } }, "archiveAgent": { "request": {}, "response": { "agent": { "id": "agent_example", "name": "Research helper", "scopeType": "standalone", "lifecycleState": "archived", "createdAt": null, "updatedAt": null } } }, "restoreAgent": { "request": {}, "response": { "agent": { "id": "agent_example", "name": "Research helper", "scopeType": "standalone", "lifecycleState": "active", "createdAt": null, "updatedAt": null } } }, "getAgentEffectiveTools": { "response": { "agentId": "agent_example", "policyRevision": 1, "providers": [], "allowedToolNames": [], "deniedToolNames": [], "staleToolNames": [], "schemaVersion": 1, "agentRef": "agent_example", "runRef": "run_example", "complete": true, "reason": null, "capabilityDigest": "4444444444444444444444444444444444444444444444444444444444444444", "skills": { "kind": "instructions", "executionAuthority": "none", "providerReadiness": "request_specific", "complete": true, "reason": null, "entries": [ { "skillId": "research-notes", "source": "skill", "availability": "available", "reason": null, "approvalClass": "none", "setupOperationIds": [], "documentationUrl": "https://neotask.ai/docs/api/list-agent-skills.md" } ] }, "approval": { "schemaVersion": 1, "agentRef": "agent_example", "observedAt": "2026-08-24T12:00:00.000Z", "policy": { "mode": "human_only", "source": { "tenantRevision": 1, "agentRevision": null }, "deterministic": { "operationIds": [], "toolNames": [] } }, "runtimeApprovalReview": "human_required", "workloadMcpApprovalReview": "human_required", "delegations": { "appliesTo": "public_agent_approval_decisions", "authority": "none", "complete": true, "grants": [] } }, "tools": [ { "toolId": "read", "source": "gateway_core", "availability": "available", "reason": null, "approvalClass": "request_specific", "approvalPolicyOperationId": "getEffectiveAgentApprovalPolicy", "setupOperationIds": [], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md" }, { "toolId": "cron", "source": "gateway_core", "availability": "available", "reason": null, "approvalClass": "request_specific", "approvalPolicyOperationId": "getEffectiveAgentApprovalPolicy", "setupOperationIds": [], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md", "actions": [ { "actionId": "status", "availability": "available", "reason": null, "approvalClass": "request_specific", "requestExceptions": [], "setupOperationIds": [], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md" }, { "actionId": "list", "availability": "available", "reason": null, "approvalClass": "request_specific", "requestExceptions": [], "setupOperationIds": [], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md" }, { "actionId": "get", "availability": "available", "reason": null, "approvalClass": "request_specific", "requestExceptions": [], "setupOperationIds": [], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md" }, { "actionId": "add", "availability": "plan_required", "reason": "plan_required", "approvalClass": "request_specific", "requestExceptions": [ "managed_memory_dreaming" ], "setupOperationIds": [ "requestAgentCheckoutHandoff" ], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md" }, { "actionId": "update", "availability": "plan_required", "reason": "plan_required", "approvalClass": "request_specific", "requestExceptions": [ "managed_memory_dreaming" ], "setupOperationIds": [ "requestAgentCheckoutHandoff" ], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md" }, { "actionId": "remove", "availability": "plan_required", "reason": "plan_required", "approvalClass": "request_specific", "requestExceptions": [ "managed_memory_dreaming" ], "setupOperationIds": [ "requestAgentCheckoutHandoff" ], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md" }, { "actionId": "run", "availability": "plan_required", "reason": "plan_required", "approvalClass": "request_specific", "requestExceptions": [ "managed_memory_dreaming" ], "setupOperationIds": [ "requestAgentCheckoutHandoff" ], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md" }, { "actionId": "runs", "availability": "available", "reason": null, "approvalClass": "request_specific", "requestExceptions": [], "setupOperationIds": [], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md" }, { "actionId": "wake", "availability": "plan_required", "reason": "plan_required", "approvalClass": "request_specific", "requestExceptions": [], "setupOperationIds": [ "requestAgentCheckoutHandoff" ], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md" } ] }, { "toolId": "workflow_run", "source": "reviewed_plugin", "availability": "temporarily_disabled", "reason": "tool_policy_denied", "approvalClass": "request_specific", "approvalPolicyOperationId": "getEffectiveAgentApprovalPolicy", "setupOperationIds": [ "getAgentToolPolicy" ], "documentationUrl": "https://neotask.ai/docs/api/get-agent-effective-tools.md" } ], "preparedRun": { "runRef": "run_example", "runtimeFlavor": "standalone-agent-runner", "capabilityDigest": "4444444444444444444444444444444444444444444444444444444444444444", "catalogDigest": "0000000000000000000000000000000000000000000000000000000000000000", "runtimeProfileDigest": "1111111111111111111111111111111111111111111111111111111111111111", "runnerInventoryDigest": "2222222222222222222222222222222222222222222222222222222222222222", "preparedInventoryDigest": "3333333333333333333333333333333333333333333333333333333333333333", "tools": [ { "toolId": "read", "source": "core", "sourceAllowed": true, "reason": null }, { "toolId": "cron", "source": "core", "sourceAllowed": true, "reason": null }, { "toolId": "workflow_run", "source": "plugin", "sourceAllowed": false, "reason": "tool_policy_denied" } ] } } }, "getAgentToolPolicy": { "response": { "agentId": "agent_example", "revision": 1, "runtimePolicy": { "schemaVersion": 1, "profile": "full", "allow": null, "deny": [] }, "policy": { "version": 1, "revision": 1, "companyId": "agent:agent_example", "defaultMode": "allow_all_connected", "appPolicies": {}, "updatedAt": 1787875200000 } } }, "updateAgentToolPolicy": { "request": { "defaultMode": "deny_all", "expectedRevision": 1, "appPolicies": {}, "runtimePolicy": { "schemaVersion": 1, "profile": "full", "allow": [ "read" ], "deny": [] } }, "response": { "agentId": "agent_example", "revision": 2, "runtimePolicy": { "schemaVersion": 1, "profile": "full", "allow": [ "read" ], "deny": [] }, "policy": { "version": 1, "revision": 2, "companyId": "agent:agent_example", "defaultMode": "deny_all", "appPolicies": {}, "updatedAt": 1787875200000 } } }, "listTasks": { "response": { "tasks": [], "nextCursor": null } }, "createTask": { "request": { "name": "First task", "instruction": "Summarize the supplied notes." }, "response": { "task": { "id": "task_example", "name": "First task", "instruction": "Summarize the supplied notes.", "status": "draft", "enabled": true, "createdAt": null, "updatedAt": null } } }, "listAgentCronJobs": { "response": { "cronJobs": [], "nextCursor": null } }, "createAgentCronJob": { "request": { "taskId": "task_example", "scheduleCron": "0 9 * * *", "scheduleTimezone": "UTC" }, "response": { "cronJob": { "id": "agent-cron-example", "taskId": "task_example", "name": "Daily task", "schedule": { "kind": "cron", "expression": "0 9 * * *", "timezone": "UTC" }, "enabled": true, "nextRunAt": null, "lastRunAt": null, "lastStatus": "scheduled" } } }, "getAgentCronJob": { "response": { "cronJob": { "id": "agent-cron-example", "taskId": "task_example", "name": "Daily task", "schedule": { "kind": "cron", "expression": "0 9 * * *", "timezone": "UTC" }, "enabled": true, "nextRunAt": null, "lastRunAt": null, "lastStatus": "scheduled" } } }, "updateAgentCronJob": { "request": { "name": "Daily task" }, "response": { "cronJob": { "id": "agent-cron-example", "taskId": "task_example", "name": "Daily task", "schedule": { "kind": "cron", "expression": "0 9 * * *", "timezone": "UTC" }, "enabled": true, "nextRunAt": null, "lastRunAt": null, "lastStatus": "scheduled" } } }, "enableAgentCronJob": { "request": {}, "response": { "cronJob": { "id": "agent-cron-example", "taskId": "task_example", "name": "Daily task", "schedule": { "kind": "cron", "expression": "0 9 * * *", "timezone": "UTC" }, "enabled": true, "nextRunAt": null, "lastRunAt": null, "lastStatus": "scheduled" } } }, "disableAgentCronJob": { "request": {}, "response": { "cronJob": { "id": "agent-cron-example", "taskId": "task_example", "name": "Daily task", "schedule": { "kind": "cron", "expression": "0 9 * * *", "timezone": "UTC" }, "enabled": false, "nextRunAt": null, "lastRunAt": null, "lastStatus": "scheduled" } } }, "runAgentCronJob": { "request": {}, "response": { "run": { "id": "run_example", "taskId": "task_example", "status": "queued", "terminal": false }, "cronJob": { "id": "agent-cron-example", "taskId": "task_example", "name": "Daily task", "schedule": { "kind": "cron", "expression": "0 9 * * *", "timezone": "UTC" }, "enabled": true, "nextRunAt": null, "lastRunAt": null, "lastStatus": "queued" } } }, "listAgentCronJobRuns": { "response": { "runs": [], "nextCursor": null } }, "deleteAgentCronJob": { "request": {}, "response": { "deleted": true, "cronJobRef": "agent-cron-example" } }, "listAgentAutomationCatalog": { "response": { "schemaVersion": 1, "kinds": [ { "kind": "task_flow", "name": "Task Flow", "description": "Managed flow", "requiredFields": [ "agentRef", "name", "instruction" ] } ], "unsupportedInputs": [ "raw_code", "shell", "credentials" ] } }, "listAgentAutomations": { "response": { "automations": [], "nextCursor": null } }, "createAgentAutomation": { "request": { "agentRef": "agent_example", "kind": "task_flow", "name": "Weekly brief", "instruction": "Prepare a brief." }, "response": { "automation": { "automationRef": "automation_example", "kind": "task_flow", "name": "Weekly brief", "description": null, "agentRef": "agent_example", "instruction": "Prepare a brief.", "model": null, "taskFlow": { "goal": "Prepare a brief.", "currentStep": null, "notifyPolicy": "done_only", "stateJson": null }, "status": "active", "revision": 1, "createdAt": null, "updatedAt": null, "latestRun": null } } }, "getAgentAutomation": { "response": { "automation": { "automationRef": "automation_example", "kind": "task_flow", "name": "Weekly brief", "description": null, "agentRef": "agent_example", "instruction": "Prepare a brief.", "model": null, "taskFlow": { "goal": "Prepare a brief.", "currentStep": null, "notifyPolicy": "done_only", "stateJson": null }, "status": "active", "revision": 1, "createdAt": null, "updatedAt": null, "latestRun": null } } }, "updateAgentAutomation": { "request": { "expectedRevision": 1, "name": "Reviewed weekly brief" }, "response": { "automation": { "automationRef": "automation_example", "kind": "task_flow", "name": "Reviewed weekly brief", "description": null, "agentRef": "agent_example", "instruction": "Prepare a brief.", "model": null, "taskFlow": { "goal": "Prepare a brief.", "currentStep": null, "notifyPolicy": "done_only", "stateJson": null }, "status": "active", "revision": 2, "createdAt": null, "updatedAt": null, "latestRun": null } } }, "deleteAgentAutomation": { "request": { "expectedRevision": 1 }, "response": { "automation": { "automationRef": "automation_example", "kind": "task_flow", "name": "Weekly brief", "description": null, "agentRef": "agent_example", "instruction": "Prepare a brief.", "model": null, "taskFlow": { "goal": "Prepare a brief.", "currentStep": null, "notifyPolicy": "done_only", "stateJson": null }, "status": "archived", "revision": 2, "createdAt": null, "updatedAt": null, "latestRun": null }, "changed": true } }, "startAgentAutomation": { "request": {}, "response": { "automationRef": "automation_example", "kind": "task_flow", "revision": 1, "run": { "id": "run_example", "taskId": "automation-task-example", "status": "queued", "terminal": false }, "eventsUrl": "/api/agent/v1/runs/run_example/events" } }, "getAgentAutomationStatus": { "response": { "automationRef": "automation_example", "kind": "task_flow", "status": "active", "revision": 1, "run": null } }, "pauseAgentAutomation": { "request": { "expectedRevision": 1 }, "response": { "automation": { "automationRef": "automation_example", "kind": "task_flow", "name": "Weekly brief", "description": null, "agentRef": "agent_example", "instruction": "Prepare a brief.", "model": null, "taskFlow": { "goal": "Prepare a brief.", "currentStep": null, "notifyPolicy": "done_only", "stateJson": null }, "status": "paused", "revision": 2, "createdAt": null, "updatedAt": null, "latestRun": null }, "changed": true } }, "resumeAgentAutomation": { "request": { "expectedRevision": 2 }, "response": { "automation": { "automationRef": "automation_example", "kind": "task_flow", "name": "Weekly brief", "description": null, "agentRef": "agent_example", "instruction": "Prepare a brief.", "model": null, "taskFlow": { "goal": "Prepare a brief.", "currentStep": null, "notifyPolicy": "done_only", "stateJson": null }, "status": "active", "revision": 3, "createdAt": null, "updatedAt": null, "latestRun": null }, "changed": true } }, "cancelAgentAutomation": { "request": { "expectedRevision": 3 }, "response": { "automationRef": "automation_example", "cancelled": true, "run": { "runRef": "run_example", "status": "cancelled" } } }, "listAgentAutomationRuns": { "response": { "automationRef": "automation_example", "runs": [], "nextCursor": null } }, "getRun": { "response": { "id": "run_example", "taskId": "task_example", "status": "queued", "terminal": false } }, "createRun": { "request": { "taskId": "task_example" }, "response": { "run": { "id": "run_example", "taskId": "task_example", "status": "queued", "terminal": false } } }, "listAgentConversationTurnEvents": { "response": { "events": [ { "channel": "neotask.agent.v1.conversations.conversation_example.turns.turn_example.events", "eventVersion": 1, "eventRef": "conversation_event_example", "sequence": 1, "cursor": "opaque_cursor_example", "conversationRef": "conversation_example", "turnRef": "turn_example", "type": "turn.completed", "occurredAt": "2026-08-28T00:00:00.000Z", "resourceGeneration": 1, "data": { "status": "completed" } } ], "nextCursor": null } }, "streamAgentConversationTurnEvents": { "response": { "channel": "neotask.agent.v1.conversations.conversation_example.turns.turn_example.events", "eventVersion": 1, "eventRef": "conversation_event_example", "sequence": 1, "cursor": "opaque_cursor_example", "conversationRef": "conversation_example", "turnRef": "turn_example", "type": "turn.completed", "occurredAt": "2026-08-28T00:00:00.000Z", "resourceGeneration": 1, "data": { "status": "completed" } } }, "listAgentRunEvents": { "response": { "events": [ { "channel": "neotask.agent.v1.runs.run_example.events", "eventVersion": 1, "eventRef": "run-event-1", "sequence": 1, "cursor": "opaque_cursor_example", "runRef": "run_example", "type": "run.completed", "occurredAt": "2026-08-28T00:00:00.000Z", "resourceGeneration": 1, "data": { "state": "succeeded" } } ], "nextCursor": null } }, "streamAgentRunEvents": { "response": { "channel": "neotask.agent.v1.runs.run_example.events", "eventVersion": 1, "eventRef": "run-event-1", "sequence": 1, "cursor": "opaque_cursor_example", "runRef": "run_example", "type": "run.completed", "occurredAt": "2026-08-28T00:00:00.000Z", "resourceGeneration": 1, "data": { "state": "completed" } } }, "listAgentApprovals": { "response": { "approvals": [], "nextCursor": null } }, "getAgentApproval": { "response": { "approval": { "approvalRef": "approval_example", "state": "pending", "title": "Confirm the requested action", "description": "The action is waiting for the configured approval authority.", "operationId": "createAgentConversation", "expiresAt": "2026-08-28T08:00:00.000Z", "createdAt": "2026-08-28T00:00:00.000Z" } } }, "createAgentApprovalHandoff": { "request": { "reason": "Please review this pending action." }, "response": { "handoff": { "handoffRef": "approval_handoff_examplexxxxxxxxxxxxxxxxxxx", "approvalRef": "approval_example", "status": "pending", "purpose": "agent_approval_review", "audience": "neotask-human-agent-approval-v1", "handoffUrl": "https://neotask.ai/account/approvals/approval_example?handoff=approval_handoff_examplexxxxxxxxxxxxxxxxxxx", "authority": "none", "expiresAt": "2026-08-28T00:15:00.000Z", "reason": "Please review this pending action." }, "handoffRef": "approval_handoff_examplexxxxxxxxxxxxxxxxxxx", "handoffUrl": "https://neotask.ai/account/approvals/approval_example?handoff=approval_handoff_examplexxxxxxxxxxxxxxxxxxx", "authority": "none" } }, "getAgentApprovalHandoff": { "response": { "handoff": { "handoffRef": "approval_handoff_examplexxxxxxxxxxxxxxxxxxx", "approvalRef": "approval_example", "status": "pending", "purpose": "agent_approval_review", "audience": "neotask-human-agent-approval-v1", "authority": "none", "expiresAt": "2026-08-28T00:15:00.000Z" }, "approval": { "approvalRef": "approval_example", "state": "pending", "title": "Confirm the requested action", "expiresAt": "2026-08-28T08:00:00.000Z" }, "authority": "none" } }, "cancelAgentApprovalHandoff": { "request": {}, "response": { "handoff": { "handoffRef": "approval_handoff_examplexxxxxxxxxxxxxxxxxxx", "approvalRef": "approval_example", "status": "cancelled", "purpose": "agent_approval_review", "audience": "neotask-human-agent-approval-v1", "authority": "none", "expiresAt": "2026-08-28T00:15:00.000Z" }, "authority": "none" } }, "listAgentApprovalEvents": { "response": { "channel": "neotask.agent.v1.approvals.approval_example.events", "approvalRef": "approval_example", "events": [ { "channel": "neotask.agent.v1.approvals.approval_example.events", "eventVersion": 1, "eventRef": "approval_event_example", "sequence": 1, "cursor": "opaque_cursor_example", "approvalRef": "approval_example", "type": "approval.requested", "occurredAt": "2026-08-28T00:00:00.000Z", "resourceGeneration": 1, "data": { "approvalState": "pending" } } ], "nextCursor": null, "hasMore": false, "retentionFloor": "opaque_cursor_floor_example", "snapshotUrl": "https://neotask.ai/api/agent/v1/approvals/approval_example" } }, "streamAgentApprovalEvents": { "response": { "channel": "neotask.agent.v1.approvals.approval_example.events", "eventVersion": 1, "eventRef": "approval_event_example", "sequence": 1, "cursor": "opaque_cursor_example", "approvalRef": "approval_example", "type": "approval.requested", "occurredAt": "2026-08-28T00:00:00.000Z", "resourceGeneration": 1, "data": { "approvalState": "pending" } } }, "getEffectiveAgentApprovalPolicy": { "response": { "schemaVersion": 1, "agentRef": "agent_example", "effective": { "mode": "human_only", "deterministic": { "operationIds": [], "toolNames": [] }, "hardGates": [ "claim", "billing", "oauth_secrets", "company_membership", "mail_membership", "install_adopt", "destructive", "security", "privacy" ] }, "source": { "tenantDefault": "implicit", "agentOverride": "none", "tenantRevision": 1, "agentRevision": null }, "revision": 1, "updatedAt": null, "updatedBy": null } }, "createAgentApprovalSettingsHandoff": { "request": { "requestedPolicy": { "mode": "policy_auto", "operationIds": [ "createAgentConversation" ] }, "reason": "Allow the reviewed conversation operation." }, "response": { "handoff": { "handoffRef": "approval_settings_handoff_example", "status": "pending", "purpose": "agent_approval_settings_change", "audience": "neotask-human-agent-approval-settings-v1", "expiresAt": "2026-08-28T00:30:00.000Z", "requestedPolicy": { "mode": "policy_auto", "operationIds": [ "createAgentConversation" ] }, "reason": "Allow the reviewed conversation operation.", "handoffUrl": "https://neotask.ai/agent-approval-settings/agent_example?handoff=approval_settings_handoff_example", "authority": "none" }, "handoffRef": "approval_settings_handoff_example", "handoffUrl": "https://neotask.ai/agent-approval-settings/agent_example?handoff=approval_settings_handoff_example", "authority": "none" } }, "getAgentApprovalSettingsHandoff": { "response": { "handoff": { "handoffRef": "approval_settings_handoff_example", "status": "pending", "purpose": "agent_approval_settings_change", "audience": "neotask-human-agent-approval-settings-v1", "expiresAt": "2026-08-28T00:30:00.000Z", "requestedPolicy": { "mode": "policy_auto", "operationIds": [ "createAgentConversation" ] }, "authority": "none" }, "authority": "none" } }, "cancelAgentApprovalSettingsHandoff": { "request": {}, "response": { "handoff": { "handoffRef": "approval_settings_handoff_example", "status": "cancelled", "purpose": "agent_approval_settings_change", "audience": "neotask-human-agent-approval-settings-v1", "expiresAt": "2026-08-28T00:30:00.000Z", "requestedPolicy": { "mode": "policy_auto", "operationIds": [ "createAgentConversation" ] }, "authority": "none" }, "authority": "none" } }, "decideAgentApproval": { "request": { "decision": "approved", "operationId": "createAgentConversation", "normalizedArgsDigest": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "scopeType": "tenant", "scopeRef": "tenant_example", "policyRevision": 1 }, "response": { "approval": { "approvalRef": "approval_example", "state": "approved", "title": "Confirm the requested action", "operationId": "createAgentConversation", "createdAt": "2026-08-28T00:00:00.000Z", "resolvedAt": "2026-08-28T00:01:00.000Z", "resolvedBy": "agent" }, "delegation": { "delegationRef": "delegation_example", "usesRemaining": 0 } } }, "listAgentAutonomyGoals": { "response": { "goals": [], "nextCursor": null } }, "createAgentAutonomyGoal": { "request": { "companyRef": "company_example", "objective": "Review the current queue." }, "response": { "goal": { "id": "goal_example", "companyRef": "company_example", "objective": "Review the current queue.", "status": "pending", "completion": null, "dependsOn": [], "taskPlan": null, "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:00:00.000Z" } } }, "getAgentAutonomyGoal": { "response": { "goal": { "id": "goal_example", "companyRef": "company_example", "objective": "Review the current queue.", "status": "pending", "completion": null, "dependsOn": [], "taskPlan": null, "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:00:00.000Z" } } }, "updateAgentAutonomyGoal": { "request": { "objective": "Review the current queue and report blockers." }, "response": { "goal": { "id": "goal_example", "companyRef": "company_example", "objective": "Review the current queue and report blockers.", "status": "pending", "completion": null, "dependsOn": [], "taskPlan": null, "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:00:00.000Z" } } }, "startAgentAutonomyGoal": { "request": {}, "response": { "goal": { "id": "goal_example", "companyRef": "company_example", "objective": "Review the current queue.", "status": "running", "completion": null, "dependsOn": [], "taskPlan": null, "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:00:00.000Z" }, "execution": { "executionRef": "execution_example", "status": "accepted" } } }, "getAgentAutonomyGoalStatus": { "response": { "goal": { "id": "goal_example", "companyRef": "company_example", "objective": "Review the current queue.", "status": "running", "completion": null, "dependsOn": [], "taskPlan": null, "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:00:00.000Z" }, "execution": { "active": true, "activeRun": { "id": "run_example", "taskId": "task_example", "status": "running", "stateSeq": 1, "startedAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:00:00.000Z" }, "runCount": 1, "taskPlan": null } } }, "steerAgentAutonomyGoal": { "request": { "text": "Prioritize the blocked items.", "kind": "redirect" }, "response": { "goal": { "id": "goal_example", "companyRef": "company_example", "objective": "Review the current queue.", "status": "running", "completion": null, "dependsOn": [], "taskPlan": null, "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:00:00.000Z" }, "run": { "runRef": "run_example", "state": "running", "stateSeq": 2, "delivered": true } } }, "pauseAgentAutonomyGoal": { "request": {}, "response": { "goal": { "id": "goal_example", "companyRef": "company_example", "objective": "Review the current queue.", "status": "paused", "completion": null, "dependsOn": [], "taskPlan": null, "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:00:00.000Z" } } }, "resumeAgentAutonomyGoal": { "request": {}, "response": { "goal": { "id": "goal_example", "companyRef": "company_example", "objective": "Review the current queue.", "status": "active", "completion": null, "dependsOn": [], "taskPlan": null, "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:00:00.000Z" } } }, "cancelAgentAutonomyGoal": { "request": {}, "response": { "goal": { "id": "goal_example", "companyRef": "company_example", "objective": "Review the current queue.", "status": "cleared", "completion": null, "dependsOn": [], "taskPlan": null, "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:00:00.000Z" }, "cancelledRun": { "runRef": "run_example", "state": "cancelled" } } }, "listAgentAutonomyGoalRuns": { "response": { "runs": [], "nextCursor": null } }, "listAgentConversations": { "response": { "conversations": [], "nextCursor": null } }, "createAgentConversation": { "request": { "agentRef": "agent_example", "title": "Research session" }, "response": { "conversation": { "id": "conv_example", "agentId": "agent_example", "status": "active", "createdAt": null, "updatedAt": null, "lastActivityAt": null } } }, "getAgentConversation": { "response": { "conversation": { "id": "conv_example", "agentId": "agent_example", "status": "active", "createdAt": null, "updatedAt": null, "lastActivityAt": null } } }, "archiveAgentConversation": { "request": {}, "response": { "conversation": { "id": "conv_example", "agentId": "agent_example", "status": "archived", "createdAt": null, "updatedAt": null, "lastActivityAt": null } } }, "restoreAgentConversation": { "request": {}, "response": { "conversation": { "id": "conv_example", "agentId": "agent_example", "status": "active", "createdAt": null, "updatedAt": null, "lastActivityAt": null } } }, "listAgentConversationMessages": { "response": { "messages": [], "nextCursor": null } }, "createAgentConversationTurn": { "request": { "input": "Summarize the latest notes." }, "response": { "turn": { "id": "turn_example", "conversationRef": "conv_example", "sequence": 1, "status": "queued", "model": null, "createdAt": null } } }, "getAgentConversationTurn": { "response": { "turn": { "id": "turn_example", "conversationRef": "conv_example", "sequence": 1, "status": "running", "model": null, "createdAt": null } } }, "cancelAgentConversationTurn": { "request": {}, "response": { "turn": { "id": "turn_example", "conversationRef": "conv_example", "sequence": 1, "status": "cancel_requested", "model": null, "createdAt": null } } }, "getUsage": { "response": { "schemaVersion": 3, "plan": { "id": "free", "displayName": "Free", "features": [], "limits": { "maxAgents": null, "maxChannels": 1, "maxDevices": 1, "maxRequestsPerMinute": 60, "maxPromptBytes": 524288, "messageLimit": 10, "usedMessages": 0, "remainingMessages": 10, "historyDays": 7, "maxCompanies": 0 }, "models": { "tier": "basic", "allowed": [ "neotask/neotask-matrix" ] } }, "usage": { "messageLimit": 10, "usedMessages": 0, "remainingMessages": 10 } } }, "listAgentSkills": { "response": { "skills": [], "keyMode": "system" } }, "listDesktopDownloadOptions": { "response": { "operationId": "listDesktopDownloadOptions", "status": "available", "availability": "available", "reason": null, "release": { "owner": "NeotaskInc", "repository": "Neotask", "version": "1.0.0", "tagName": "v1.0.0", "publishedAt": "2026-08-28T00:00:00.000Z", "releaseUrl": "https://github.com/NeotaskInc/Neotask/releases/tag/v1.0.0" }, "downloads": { "mac": [ { "name": "Neotask-1.0.0-arm64.dmg", "url": "https://github.com/NeotaskInc/Neotask/releases/download/v1.0.0/Neotask-1.0.0-arm64.dmg" } ], "windows": [], "linux": [] }, "integrity": { "verified": true, "manifestVersion": 2, "signatureAlgorithm": "Ed25519", "signatureKeyId": "attestation-example", "expiresAt": "2026-08-28T00:05:00.000Z" } } }, "requestAgentCheckoutHandoff": { "request": { "operation": "cron.create", "requiredFeature": "cron" }, "response": { "error": { "code": "plan_required", "message": "The current plan does not include cron.create.", "operation": "cron.create", "requiredFeature": "cron", "eligiblePlans": [ "business", "enterprise" ], "checkoutUrl": "https://neotask.ai/agent-upgrade/example-handoff" } } }, "requestAgentSkillConfiguration": { "request": { "requestedFields": [ "GOOGLE_CLIENT_ID" ], "reason": "Connect the selected skill." }, "response": { "operationId": "requestAgentSkillConfiguration", "status": "pending", "availability": "setup_required", "reason": "human_configuration_required", "skill": { "skillId": "google-calendar", "displayName": "Google Calendar", "description": "Read and manage calendar events.", "authMode": "oauth", "requiredConnections": [ "google-calendar" ] }, "requestedFields": [ "GOOGLE_CLIENT_ID" ], "missingConfigurationFields": [ "GOOGLE_CLIENT_ID" ], "requiredFields": [ { "key": "GOOGLE_CLIENT_ID", "label": "Google client ID", "description": "OAuth client identifier.", "sensitive": true } ], "humanAction": { "required": true, "type": "human_configuration", "authority": "human_only", "url": null }, "requestReason": "Connect the selected skill." } }, "getAgentMcpCatalog": { "response": { "ok": true, "operationId": "getAgentMcpCatalog", "status": "available", "availability": "available", "reason": null, "version": "mcp-catalog-v1", "entries": [ { "providerKey": "example-calendar", "slug": "example-calendar", "name": "Example Calendar", "category": "productivity", "description": "Calendar tools.", "capabilityDescription": "Read and manage calendar events.", "authProvider": "oauth", "reviewedAuthClassification": "oauth", "status": "active", "tools": [ "calendar_list_events" ], "toolCount": 1, "toolsSource": "static", "toolsObservedAt": null } ] } }, "getAgentCliMetadata": { "response": { "operationId": "getAgentCliMetadata", "status": "available", "availability": "available", "reason": null, "contract": { "version": "v1", "restResource": "https://neotask.ai/api/agent", "mcpResource": "https://neotask.ai/mcp", "capabilitiesPath": "/api/agent/v1/capabilities" }, "auth": { "scheme": "Bearer", "restAudience": "https://neotask.ai/api/agent", "mcpAudience": "https://neotask.ai/mcp", "registration": "Use the documented agent registration flow." }, "distribution": { "status": "temporarily_disabled", "reason": "signed_release_not_published", "channels": [] }, "commands": [ "neotask auth register", "neotask api capabilities get" ], "runner": { "hmacBoundary": "site_to_runner_only" }, "compatibility": { "electronGateway": true, "mcp": true } } }, "listAgentModels": { "response": { "models": [], "plan": { "id": "free", "tier": "basic", "keyMode": "system" }, "defaultModel": "neotask/neotask-matrix" } }, "setAgentModel": { "request": { "model": "neotask/neotask-matrix" }, "response": { "agent": { "id": "agent_example", "model": "neotask/neotask-matrix", "provider": "neotask" } } }, "revokeAgentRegistration": { "request": {}, "response": { "revoked": true, "registrationId": "reg_example" } }, "createAgentAccountPairingHandoff": { "request": {}, "response": { "handoffRef": "pairing_ref_examplexxxxxxxxxxxxxxxxxxxxxxxx", "handoffUrl": "https://neotask.ai/api/account/agent-pairing-handoffs/pairing_ref_examplexxxxxxxxxxxxxxxxxxxxxxxx?state=pairing_state_examplexxxxxxxxxxxxxxxxxxxxxx", "status": "pending", "expiresAt": "2026-08-28T00:15:00.000Z", "audience": "neotask-human-account-pairing-v1" } }, "getAgentAccountPairingHandoff": { "response": { "handoffRef": "pairing_ref_examplexxxxxxxxxxxxxxxxxxxxxxxx", "status": "pending", "expiresAt": "2026-08-28T00:15:00.000Z" } }, "cancelAgentAccountPairingHandoff": { "request": {}, "response": { "handoffRef": "pairing_ref_examplexxxxxxxxxxxxxxxxxxxxxxxx", "status": "cancelled", "expiresAt": "2026-08-28T00:15:00.000Z" } }, "getAgentMailCapabilities": { "response": { "mail": { "availability": "available", "available": true, "reason": null, "company": { "id": "company_example", "name": "Example Company" }, "identity": { "agentId": "agent_example", "label": "Research agent", "program": "neotask-agent-api", "model": null, "parentAgentId": null, "sessionId": null, "runId": null, "capabilities": [], "status": "active", "firstSeenAt": null, "lastSeenAt": null } }, "operations": [] } }, "requestAgentMailMembership": { "request": { "companyRef": "company_example" }, "response": { "membership": { "membershipId": "membership_example", "status": "pending", "company": { "id": "company_example", "name": "Example Company" }, "agent": { "id": "agent-api:reg_example" }, "requestedAt": "2026-08-28T00:00:00.000Z", "approvedAt": null, "suspendedAt": null, "leftAt": null, "revokedAt": null, "lastTransitionAt": "2026-08-28T00:00:00.000Z", "reason": null } } }, "joinAgentMailMembership": { "request": { "membershipId": "membership_example" }, "response": { "membership": { "membershipId": "membership_example", "status": "active", "company": { "id": "company_example", "name": "Example Company" }, "agent": { "id": "agent-api:reg_example" }, "requestedAt": "2026-08-28T00:00:00.000Z", "approvedAt": "2026-08-28T00:05:00.000Z", "suspendedAt": null, "leftAt": null, "revokedAt": null, "lastTransitionAt": "2026-08-28T00:05:30.000Z", "reason": null } } }, "getAgentMailMembership": { "response": { "memberships": [] } }, "approveAgentMailMembership": { "request": { "membershipId": "membership_example", "reason": "Approved for company coordination." }, "response": { "membership": { "membershipId": "membership_example", "status": "approved", "company": { "id": "company_example", "name": "Example Company" }, "agent": { "id": "agent-api:reg_example" }, "requestedAt": "2026-08-28T00:00:00.000Z", "approvedAt": "2026-08-28T00:06:00.000Z", "suspendedAt": null, "leftAt": null, "revokedAt": null, "lastTransitionAt": "2026-08-28T00:06:00.000Z", "reason": "Approved for company coordination." } } }, "suspendAgentMailMembership": { "request": { "membershipId": "membership_example", "reason": "Temporarily paused." }, "response": { "membership": { "membershipId": "membership_example", "status": "suspended", "company": { "id": "company_example", "name": "Example Company" }, "agent": { "id": "agent-api:reg_example" }, "requestedAt": "2026-08-28T00:00:00.000Z", "approvedAt": "2026-08-28T00:06:00.000Z", "suspendedAt": "2026-08-28T00:07:00.000Z", "leftAt": null, "revokedAt": null, "lastTransitionAt": "2026-08-28T00:07:00.000Z", "reason": "Temporarily paused." } } }, "leaveAgentMailMembership": { "request": { "membershipId": "membership_example" }, "response": { "membership": { "membershipId": "membership_example", "status": "left", "company": { "id": "company_example", "name": "Example Company" }, "agent": { "id": "agent-api:reg_example" }, "requestedAt": "2026-08-28T00:00:00.000Z", "approvedAt": "2026-08-28T00:06:00.000Z", "suspendedAt": null, "leftAt": "2026-08-28T00:08:00.000Z", "revokedAt": null, "lastTransitionAt": "2026-08-28T00:08:00.000Z", "reason": null } } }, "revokeAgentMailMembership": { "request": { "membershipId": "membership_example", "reason": "Access ended." }, "response": { "membership": { "membershipId": "membership_example", "status": "revoked", "company": { "id": "company_example", "name": "Example Company" }, "agent": { "id": "agent-api:reg_example" }, "requestedAt": "2026-08-28T00:00:00.000Z", "approvedAt": "2026-08-28T00:06:00.000Z", "suspendedAt": null, "leftAt": null, "revokedAt": "2026-08-28T00:09:00.000Z", "lastTransitionAt": "2026-08-28T00:09:00.000Z", "reason": "Access ended." } } }, "listAgentMailIdentities": { "response": { "identities": [], "nextCursor": null } }, "getAgentMailIdentity": { "response": { "identity": { "agentId": "agent_example", "label": "Research agent", "program": "neotask-agent-api", "model": null, "parentAgentId": null, "sessionId": null, "runId": null, "capabilities": [], "status": "active", "firstSeenAt": null, "lastSeenAt": null }, "company": { "id": "company_example", "name": "Example Company" } } }, "listAgentMailPeers": { "response": { "peers": [], "nextCursor": null } }, "getAgentMailPeer": { "response": { "peer": { "agentId": "agent_peer_example", "label": "Operations agent", "program": "neotask-agent-api", "model": null, "parentAgentId": null, "sessionId": null, "runId": null, "capabilities": [], "status": "active", "firstSeenAt": null, "lastSeenAt": null }, "company": { "id": "company_example", "name": "Example Company" } } }, "sendAgentMailMessage": { "request": { "to": [ "agent_peer_example" ], "subject": "Status update", "bodyMd": "The task is complete.", "ackRequired": true }, "response": { "message": { "messageId": "message_example", "threadId": "thread_example", "senderAgentId": "agent_example", "to": [ { "type": "agent", "agentId": "agent_peer_example" } ], "cc": [], "subject": "Status update", "bodyMd": "The task is complete.", "importance": "normal", "ackRequired": true, "artifactRefs": [], "trace": null, "sentAt": "2026-08-28T00:00:00.000Z", "retainedUntil": null }, "delivery": { "recipientCount": 1 } } }, "replyAgentMailMessage": { "request": { "bodyMd": "Thanks. I have it." }, "response": { "message": { "messageId": "reply_example", "threadId": "thread_example", "senderAgentId": "agent_peer_example", "to": [ { "type": "agent", "agentId": "agent_example" } ], "cc": [], "subject": "Re: Status update", "bodyMd": "Thanks. I have it.", "importance": "normal", "ackRequired": false, "artifactRefs": [], "trace": null, "sentAt": "2026-08-28T00:01:00.000Z", "retainedUntil": null }, "delivery": { "recipientCount": 1 } } }, "listAgentMailInbox": { "response": { "messages": [], "nextCursor": null } }, "getAgentMailEvents": { "response": { "events": [], "nextCursor": null } }, "getAgentMailDelivery": { "response": { "messageId": "message_example", "deliveries": [ { "messageId": "message_example", "recipientAgentId": "agent_peer_example", "state": "delivered", "stateAt": "2026-08-28T00:00:30.000Z" } ] } }, "acknowledgeAgentMailDelivery": { "request": {}, "response": { "delivery": { "messageId": "message_example", "recipientAgentId": "agent_peer_example", "state": "acked", "stateAt": "2026-08-28T00:02:00.000Z" } } }, "markAgentMailRead": { "request": {}, "response": { "delivery": { "messageId": "message_example", "recipientAgentId": "agent_peer_example", "state": "read", "stateAt": "2026-08-28T00:03:00.000Z" } } }, "announceAgentMailHandoff": { "request": { "subject": "Deploy handoff", "summary": "Continue deployment verification.", "subjectRef": "run:run_example", "targetAgentIds": [ "agent_peer_example" ], "threadId": null }, "response": { "handoff": { "handoffRef": "handoff_example", "agentId": "agent_example", "status": "announced", "subjectRef": "run:run_example", "subjectKind": "run", "runId": "run_example", "targetAgentIds": [ "agent_peer_example" ], "subject": "Deploy handoff", "summary": "Continue deployment verification.", "threadId": null, "traceRefs": [], "createdAt": "2026-08-28T00:00:00.000Z", "retainedUntil": null }, "message": { "messageId": "message_example", "threadId": "thread_example", "senderAgentId": "agent_example", "to": [ { "type": "agent", "agentId": "agent_peer_example" } ], "cc": [], "subject": "Deploy handoff", "bodyMd": "Continue deployment verification.", "importance": "normal", "ackRequired": false, "artifactRefs": [], "trace": null, "sentAt": "2026-08-28T00:00:00.000Z", "retainedUntil": null } } }, "attachAgentMailTrace": { "request": { "traceRef": "trace_example", "runId": "run_example", "taskRunId": "task_run_example" }, "response": { "handoffRef": "handoff_example", "trace": { "traceRef": "trace_example", "handoffRef": "handoff_example", "runId": "run_example", "taskRunId": "task_run_example", "attachedAt": "2026-08-28T00:00:00.000Z", "retainedUntil": null } } }, "broadcastAgentMailSector": { "request": { "subject": "Sector update", "bodyMd": "The release is ready." }, "response": { "message": { "messageId": "message_example", "threadId": "thread_example", "senderAgentId": "agent_example", "to": [ { "type": "agent", "agentId": "agent_peer_example" } ], "cc": [], "subject": "Sector update", "bodyMd": "The release is ready.", "importance": "normal", "ackRequired": false, "artifactRefs": [], "trace": null, "sentAt": "2026-08-28T00:00:00.000Z", "retainedUntil": null }, "delivery": { "recipientCount": 1 }, "sectorId": "operations", "recipientCount": 1 } }, "eraseAgentMailData": { "request": { "confirm": true }, "response": { "erasureRef": "erasure_example", "status": "completed", "counts": { "messages": 0, "deliveries": 0, "threads": 0, "identities": 0, "memberships": 0, "sectors": 0, "contacts": 0, "handoffs": 0, "traces": 0, "policies": 0 }, "completedAt": "2026-08-28T00:10:00.000Z" } }, "exportAgentMailData": { "request": { "limit": 1000 }, "response": { "exportRef": "export_example", "status": "ready", "snapshotDigest": "0000000000000000000000000000000000000000000000000000000000000000", "expiresAt": "2026-08-29T00:00:00.000Z", "data": { "schemaVersion": 1, "company": { "id": "company_example", "name": "Example Company" }, "exportedAt": "2026-08-28T00:00:00.000Z", "messages": [], "deliveries": [], "threads": [], "contacts": [], "sectors": [], "handoffs": [], "traces": [] } } }, "getAgentMailSectorFeed": { "response": { "sector": { "sectorId": "operations", "name": "operations", "description": null, "memberCount": 1, "updatedAt": null }, "messages": [], "nextCursor": null } }, "getAgentMailThread": { "response": { "thread": { "threadId": "thread_example", "kind": "adhoc", "refId": "thread_example", "subject": null, "participantAgentIds": [ "agent_example" ], "lastActivityAt": null, "retainedUntil": null }, "messages": [], "nextCursor": null } }, "listAgentMailContacts": { "response": { "contacts": [], "nextCursor": null } }, "listAgentMailSectors": { "response": { "sectors": [], "nextCursor": null } }, "recoverAgentMailEvents": { "request": { "cursor": "opaque_cursor", "limit": 100 }, "response": { "events": [], "nextCursor": null } }, "requestAgentMailContact": { "request": { "toAgentId": "agent_peer_example" }, "response": { "contact": { "contactId": "contact_example", "fromAgentId": "agent_example", "toAgentId": "agent_peer_example", "state": "pending", "updatedAt": null } } }, "respondAgentMailContact": { "request": { "decision": "accepted" }, "response": { "contact": { "contactId": "contact_example", "fromAgentId": "agent_example", "toAgentId": "agent_peer_example", "state": "accepted", "updatedAt": null } } }, "revokeAgentMailAccess": { "request": { "reason": "Access ended." }, "response": { "revoked": true, "memberships": 1, "identities": 1, "reason": "Access ended." } }, "searchAgentMailThreads": { "request": { "query": "deploy", "limit": 50 }, "response": { "matches": [], "nextCursor": null } }, "setAgentMailContactPolicy": { "request": { "mode": "approval_required", "allowAgentIds": [] }, "response": { "policy": { "mode": "approval_required", "allowAgentIds": [], "revision": 1, "updatedAt": "2026-08-28T00:00:00.000Z" } } }, "summarizeAgentMailThread": { "request": {}, "response": { "threadId": "thread_example", "summary": "Deployment discussion.", "generatedAt": "2026-08-28T00:10:00.000Z" } }, "waitForAgentMailEvents": { "request": { "cursor": "opaque_cursor", "waitMs": 1000 }, "response": { "events": [], "nextCursor": null, "waitedMs": 1000 } }, "createRunnerEnrollment": { "request": { "installationId": "install_example", "runnerSecret": "runner-secret-material-is-never-returned-to-the-agent", "clientType": "cli", "runtimeOwner": "cli", "platform": "linux", "architecture": "x64", "runnerVersion": "0.1.0", "gatewayProtocolVersion": 1, "runnerProtocolVersion": 1, "capabilities": [], "maxConcurrency": 1 }, "response": { "runnerId": "rnr_example", "status": "enrolling", "hmacGeneration": 1, "runnerGeneration": 1, "leaseGeneration": 1, "confirmation": { "required": true, "challenge": "opaque_confirmation_challenge", "expiresAt": "2026-08-28T00:10:00.000Z" }, "expiresAt": "2026-08-28T00:15:00.000Z" } }, "listAgentRunners": { "response": { "runners": [] } }, "rotateAgentRunner": { "request": { "newRunnerSecret": "rotated-runner-secret-material-is-never-returned" }, "response": { "runner": { "runnerId": "rnr_example", "label": "Local runner", "clientType": "cli", "runtimeOwner": "cli", "platform": "linux", "architecture": "x64", "runnerVersion": "1.0.0", "gatewayProtocolVersion": 1, "runnerProtocolVersion": 1, "capabilities": [ "gateway", "mcp", "mail" ], "capabilityHash": "0000000000000000000000000000000000000000000000000000000000000000", "maxConcurrency": 1, "status": "active", "hmacGeneration": 2, "runnerGeneration": 1, "leaseGeneration": 1, "lastSeenAt": "2026-08-28T00:05:00.000Z", "heartbeatExpiresAt": "2026-08-28T00:10:00.000Z", "revokedAt": null } } }, "revokeAgentRunner": { "request": {}, "response": { "runner": { "runnerId": "rnr_example", "label": "Local runner", "clientType": "cli", "runtimeOwner": "cli", "platform": "linux", "architecture": "x64", "runnerVersion": "1.0.0", "gatewayProtocolVersion": 1, "runnerProtocolVersion": 1, "capabilities": [ "gateway", "mcp", "mail" ], "capabilityHash": "0000000000000000000000000000000000000000000000000000000000000000", "maxConcurrency": 1, "status": "revoked", "hmacGeneration": 1, "runnerGeneration": 1, "leaseGeneration": 1, "lastSeenAt": "2026-08-28T00:05:00.000Z", "heartbeatExpiresAt": "2026-08-28T00:10:00.000Z", "revokedAt": "2026-08-28T00:10:00.000Z" } } }, "listAgentIntegrationCatalog": { "response": { "schemaVersion": 1, "catalogVersion": "agent-integrations-v1", "entries": [ { "providerId": "calendar_example", "name": "Example Calendar", "description": "Read calendar events.", "category": "calendar", "authProvider": "calendar_example", "capabilities": [ "events.read" ], "scopesSupported": [], "tools": [], "serviceUrl": null, "authDocsUrl": null, "reason": null, "authType": "oauth", "connectReady": true, "compatibility": "supported", "targetTypes": [ "tenant", "company" ] } ], "targets": [ { "scopeType": "tenant", "scopeRef": "tenant", "label": "Current account" } ] } }, "listAgentIntegrationConnections": { "response": { "scope": { "scopeType": "tenant", "scopeRef": "tenant", "label": "Current account" }, "connections": [] } }, "createAgentIntegrationAttempt": { "request": { "providerId": "calendar_example", "scopeType": "tenant", "capabilities": [ "events.read" ] }, "response": { "attemptId": "ia_example", "providerId": "calendar_example", "authType": "oauth", "scopeType": "tenant", "scopeRef": "tenant", "requestedCapabilities": [ "events.read" ], "state": "human_action_required", "connectionId": "ic_example", "connectionGeneration": 1, "humanAction": { "type": "open_url", "url": "https://neotask.ai/integrations/authorize/ia_example", "expiresAt": "2026-08-28T00:15:00.000Z" } } }, "getAgentIntegrationAttempt": { "response": { "attemptId": "ia_example", "providerId": "calendar_example", "authType": "oauth", "scopeType": "tenant", "scopeRef": "tenant", "requestedCapabilities": [ "events.read" ], "state": "connected", "connectionId": "ic_example", "connectionGeneration": 2 } }, "cancelAgentIntegrationAttempt": { "request": {}, "response": { "attemptId": "ia_example", "providerId": "calendar_example", "authType": "oauth", "scopeType": "tenant", "scopeRef": "tenant", "requestedCapabilities": [ "events.read" ], "state": "cancelled" } }, "attachAgentIntegration": { "request": { "agentRef": "agent_example", "scopeType": "tenant", "generation": 1 }, "response": { "connectionId": "ic_example", "providerId": "calendar_example", "authType": "oauth", "scopeType": "tenant", "scopeRef": "tenant", "state": "attached", "grantedCapabilities": [ "events.read" ], "attachedAgentIds": [ "agent_example" ], "accountLabel": null, "expiresAt": null, "lastVerifiedAt": null, "generation": 2 } }, "detachAgentIntegration": { "request": { "agentRef": "agent_example", "generation": 1 }, "response": { "connectionId": "ic_example", "providerId": "calendar_example", "authType": "oauth", "scopeType": "tenant", "scopeRef": "tenant", "state": "available", "grantedCapabilities": [ "events.read" ], "attachedAgentIds": [], "accountLabel": null, "expiresAt": null, "lastVerifiedAt": null, "generation": 2 } }, "revokeAgentIntegration": { "request": { "generation": 1 }, "response": { "connection": { "connectionId": "ic_example", "providerId": "calendar_example", "authType": "oauth", "scopeType": "tenant", "scopeRef": "tenant", "state": "revoked", "grantedCapabilities": [ "events.read" ], "attachedAgentIds": [], "accountLabel": null, "expiresAt": null, "lastVerifiedAt": null, "generation": 2 }, "providerRevocation": { "status": "completed" } } }, "getHumanAgentIntegrationCredentialHandoff": { "response": { "attemptId": "ia_example", "providerId": "provider_example", "authType": "api_key", "state": "human_action_required", "scopeType": "tenant", "expiresAt": "2026-08-28T00:15:00.000Z", "configured": false, "fingerprint": null, "lastVerifiedAt": null, "missingFields": [ "apiKey" ], "connectionId": null } }, "completeHumanAgentIntegrationCredentialHandoff": { "request": { "apiKey": "replace-with-your-provider-api-key" }, "response": { "attemptId": "ia_example", "providerId": "provider_example", "authType": "api_key", "state": "setup_requested", "scopeType": "tenant", "expiresAt": "2026-08-28T00:15:00.000Z", "configured": true, "fingerprint": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "lastVerifiedAt": null, "missingFields": [], "connectionId": "ic_example" } }, "getHumanAgentAccountPairingHandoff": { "response": { "status": "pending", "expiresAt": "2026-08-28T00:15:00.000Z", "workspace": { "existingTenant": true, "selected": true, "createsNewTenant": false }, "agent": { "registered": true, "status": "active", "control": "pending" }, "account": { "preservesExistingTenant": true, "changesBilling": false, "mergesAccounts": false }, "resources": { "preserved": true }, "runner": { "adoption": "separate_human_confirmed_step" }, "confirmation": { "required": true, "method": "POST", "path": "/api/account/agent-pairing-handoffs/{handoffRef}/confirm" } } }, "confirmHumanAgentAccountPairingHandoff": { "request": { "state": "sssssssssssssssssssssssssssssssssssssssssss" }, "response": { "status": "consumed", "tenantLinked": true, "idempotent": false, "electron": { "status": "not_available", "nextAction": "human_confirmed_adoption_required" } } }, "getHumanAgentApprovalSettings": { "response": { "schemaVersion": 1, "agentRef": "agent_example", "effective": { "mode": "human_only", "deterministic": { "operationIds": [], "toolNames": [] }, "hardGates": [ "claim", "billing", "oauth_secrets", "company_membership", "mail_membership", "install_adopt", "destructive", "security", "privacy" ] }, "source": { "tenantDefault": "implicit", "agentOverride": "none", "tenantRevision": 1, "agentRevision": null }, "revision": 1, "updatedAt": null, "updatedBy": null, "editor": { "tenant": { "mode": "human_only", "operationIds": [], "toolNames": [] }, "agent": { "mode": "human_only", "operationIds": [], "toolNames": [] }, "reviewedAuto": { "operationIds": [ "createAgentConversation", "createTask" ], "toolNames": [ "neotask_conversations_create", "neotask_tasks_create" ] }, "delegableOperationIds": [ "createAgentConversation", "createTask" ], "scope": { "type": "standalone_agent", "ref": "agent_example" } } } }, "prepareHumanAgentApprovalReview": { "request": {}, "response": { "ok": true, "handoffRef": "hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh", "review": { "schemaVersion": 1, "authority": "human_session", "approvalRef": "runner:0000000000000000000000000000000000000000000000000000000000000000", "reviewHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "status": "pending", "handoff": { "status": "pending", "expiresAt": "2026-09-10T15:45:00.000Z" }, "request": { "title": "Confirm the requested action", "kind": "confirm", "type": "high_risk_action", "riskLevel": "medium", "agentRef": "agent_example", "intentFields": [] } } } }, "getHumanAgentApprovalReview": { "response": { "ok": true, "review": { "schemaVersion": 1, "authority": "human_session", "approvalRef": "approval_example", "reviewHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "status": "pending", "handoff": { "status": "pending", "expiresAt": "2026-09-10T15:45:00.000Z" }, "request": { "title": "Confirm the requested action", "kind": "confirm", "type": "high_risk_action", "riskLevel": "medium", "agentRef": "agent_example", "intentFields": [] } } } }, "decideHumanAgentApprovalReview": { "request": { "expectedReviewHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "decision": "approved" }, "response": { "ok": true, "review": { "schemaVersion": 1, "authority": "human_session", "approvalRef": "approval_example", "reviewHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "status": "approved", "handoff": { "status": "completed", "expiresAt": "2026-09-10T15:45:00.000Z" }, "request": { "title": "Confirm the requested action", "kind": "confirm", "type": "high_risk_action", "riskLevel": "medium", "agentRef": "agent_example", "intentFields": [] }, "resolution": { "decision": "approved", "at": "2026-09-10T15:31:00.000Z", "by": "000000000000000000000001" } } } }, "updateHumanAgentApprovalSettings": { "request": { "scope": "agent", "mode": "policy_auto", "operationIds": [ "createAgentConversation" ] }, "response": { "schemaVersion": 1, "agentRef": "agent_example", "effective": { "mode": "policy_auto", "deterministic": { "operationIds": [ "createAgentConversation" ], "toolNames": [] }, "hardGates": [ "claim", "billing", "oauth_secrets", "company_membership", "mail_membership", "install_adopt", "destructive", "security", "privacy" ] }, "source": { "tenantDefault": "implicit", "agentOverride": "configured", "tenantRevision": 1, "agentRevision": 2 }, "revision": 2, "updatedAt": null, "updatedBy": null, "updated": "agent", "savedRevision": 2 } }, "listHumanAgentApprovalDelegations": { "response": { "delegations": [], "nextCursor": null } }, "cancelHumanAgentApprovalSettingsHandoff": { "request": {}, "response": { "authority": "none", "handoff": { "handoffRef": "hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh", "status": "cancelled", "purpose": "agent_approval_settings_change", "audience": "neotask-human-agent-approval-settings-v1", "authority": "none", "expiresAt": "2026-09-15T12:00:00.000Z", "cancelledAt": "2026-09-14T12:00:00.000Z", "requestedPolicy": { "mode": "agent_delegate" } } } }, "createHumanAgentApprovalDelegation": { "request": { "principalRef": "000000000000000000000001", "agentRef": "agent_example", "operationId": "createAgentConversation", "toolName": "neotask_conversations_create", "normalizedArgsDigest": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "scopeType": "tenant", "scopeRef": "tenant_example", "policyRevision": 2, "maxUses": 1, "expiresAt": "2026-08-29T00:00:00.000Z" }, "response": { "delegation": { "delegationRef": "delegation_example", "agentRef": "agent_example", "principalRef": "000000000000000000000001", "operationId": "createAgentConversation", "normalizedArgsDigest": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "scope": { "type": "standalone_agent", "ref": "agent_example" }, "authorityGeneration": 1, "policyRevision": 2, "limits": { "maxUses": 1, "used": 0, "remaining": 1 }, "expiresAt": "2026-08-29T00:00:00.000Z", "status": "active", "createdAt": "2026-08-28T00:00:00.000Z" }, "delegationRef": "delegation_example" } }, "getHumanAgentApprovalDelegation": { "response": { "delegation": { "delegationRef": "delegation_example", "agentRef": "agent_example", "principalRef": "000000000000000000000001", "operationId": "createAgentConversation", "normalizedArgsDigest": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "scope": { "type": "standalone_agent", "ref": "agent_example" }, "authorityGeneration": 1, "policyRevision": 2, "limits": { "maxUses": 1, "used": 0, "remaining": 1 }, "expiresAt": "2026-08-29T00:00:00.000Z", "status": "active", "createdAt": "2026-08-28T00:00:00.000Z" } } }, "revokeHumanAgentApprovalDelegation": { "request": {}, "response": { "delegation": { "delegationRef": "delegation_example", "agentRef": "agent_example", "principalRef": "000000000000000000000001", "operationId": "createAgentConversation", "normalizedArgsDigest": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "scope": { "type": "standalone_agent", "ref": "agent_example" }, "authorityGeneration": 1, "policyRevision": 2, "limits": { "maxUses": 1, "used": 0, "remaining": 1 }, "expiresAt": "2026-08-29T00:00:00.000Z", "status": "revoked", "createdAt": "2026-08-28T00:00:00.000Z", "revokedAt": "2026-08-28T00:10:00.000Z" } } }, "listHumanAgentRegistrations": { "response": { "registrations": [ { "registrationRef": "reg_example", "label": "Build agent", "identityMode": "service_auth", "trustLevel": "trusted", "authorityPhase": "claimed", "status": "active", "firstClaimedAt": "2026-08-28T00:00:00.000Z", "lastAuthenticatedAt": "2026-08-28T00:05:00.000Z", "lastUsedAt": "2026-08-28T00:05:00.000Z", "revokedAt": null, "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:05:00.000Z" } ] } }, "updateHumanAgentRegistrationLabel": { "request": { "label": "Build agent" }, "response": { "registration": { "registrationRef": "reg_example", "label": "Build agent", "identityMode": "service_auth", "trustLevel": "trusted", "authorityPhase": "claimed", "status": "active", "firstClaimedAt": "2026-08-28T00:00:00.000Z", "lastAuthenticatedAt": "2026-08-28T00:05:00.000Z", "lastUsedAt": "2026-08-28T00:05:00.000Z", "revokedAt": null, "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:05:00.000Z" } } }, "revokeHumanAgentRegistration": { "request": {}, "response": { "revoked": true, "registration": { "registrationRef": "reg_example", "label": "Build agent", "identityMode": "service_auth", "trustLevel": "trusted", "authorityPhase": "claimed", "status": "revoked", "firstClaimedAt": "2026-08-28T00:00:00.000Z", "lastAuthenticatedAt": "2026-08-28T00:05:00.000Z", "lastUsedAt": "2026-08-28T00:05:00.000Z", "revokedAt": "2026-08-28T00:10:00.000Z", "createdAt": "2026-08-28T00:00:00.000Z", "updatedAt": "2026-08-28T00:10:00.000Z" } } }, "listHumanAgentRunners": { "response": { "runners": [ { "runnerRef": "rnr_example", "label": "Local runner", "clientType": "cli", "runtimeOwner": "cli", "platform": "linux", "architecture": "x64", "runnerVersion": "1.0.0", "gatewayProtocolVersion": 1, "runnerProtocolVersion": 1, "capabilities": [ "gateway", "mcp", "mail" ], "capabilityHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "maxConcurrency": 1, "status": "active", "hmacGeneration": 1, "lastSeenAt": "2026-08-28T00:05:00.000Z", "lastLeaseAt": "2026-08-28T00:04:00.000Z", "lastUsedAt": "2026-08-28T00:05:00.000Z", "heartbeatExpiresAt": "2026-08-28T00:10:00.000Z", "revokedAt": null } ] } }, "inspectHumanRunnerEnrollmentReview": { "response": { "schemaVersion": 1, "authority": "human_session", "reviewRef": "rer_00000000000000000000000000000000", "reviewHash": "0000000000000000000000000000000000000000000000000000000000000000", "status": "pending", "expiresAt": "2026-09-17T00:00:00.000Z", "installation": { "installationFingerprint": "1111111111111111111111111111111111111111111111111111111111111111", "label": "Local runner", "clientType": "cli", "runtimeOwner": "cli", "platform": "darwin", "architecture": "arm64", "runnerVersion": "2026.9.1", "gatewayProtocolVersion": 1, "runnerProtocolVersion": 1, "capabilities": [ "gateway", "mcp", "mail" ], "capabilityHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "maxConcurrency": 1 } } }, "inspectHumanAgentClaimMove": { "response": { "schemaVersion": 1, "authority": "human_session", "moveRef": "acm_00000000000000000000000000000000", "reviewHash": "0000000000000000000000000000000000000000000000000000000000000000", "status": "pending", "expiresAt": "2026-09-27T00:00:00.000Z", "account": { "name": "Example account", "selection": "workos_account", "plan": { "displayName": "Free", "freeMessageQuota": true } }, "agent": { "registrationSuffix": "A1B2C3" }, "contents": { "agents": 1, "conversations": 2, "messages": 6, "tasks": 1, "runs": 3, "runners": 1, "freeMessagesUsed": 3 } } }, "resolveHumanAgentClaimMove": { "request": { "reviewHash": "0000000000000000000000000000000000000000000000000000000000000000", "decision": "confirm" }, "response": { "schemaVersion": 1, "authority": "human_session", "moveRef": "acm_00000000000000000000000000000000", "reviewHash": "0000000000000000000000000000000000000000000000000000000000000000", "status": "completed", "expiresAt": "2026-09-27T00:00:00.000Z", "account": { "name": "Example account", "selection": "workos_account", "plan": { "displayName": "Free", "freeMessageQuota": true } }, "agent": { "registrationSuffix": "A1B2C3" }, "contents": { "agents": 1, "conversations": 2, "messages": 6, "tasks": 1, "runs": 3, "runners": 1, "freeMessagesUsed": 3 }, "resolvedAt": "2026-09-26T00:10:00.000Z" } }, "resolveHumanRunnerEnrollmentReview": { "request": { "reviewHash": "0000000000000000000000000000000000000000000000000000000000000000", "decision": "approve" }, "response": { "schemaVersion": 1, "authority": "human_session", "reviewRef": "rer_00000000000000000000000000000000", "reviewHash": "0000000000000000000000000000000000000000000000000000000000000000", "status": "approved", "expiresAt": "2026-09-17T00:00:00.000Z", "installation": { "installationFingerprint": "1111111111111111111111111111111111111111111111111111111111111111", "label": "Local runner", "clientType": "cli", "runtimeOwner": "cli", "platform": "darwin", "architecture": "arm64", "runnerVersion": "2026.9.1", "gatewayProtocolVersion": 1, "runnerProtocolVersion": 1, "capabilities": [ "gateway", "mcp", "mail" ], "capabilityHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "maxConcurrency": 1 }, "resolvedAt": "2026-09-16T00:10:00.000Z" } }, "updateHumanAgentRunnerLabel": { "request": { "label": "Local runner" }, "response": { "runner": { "runnerRef": "rnr_example", "label": "Local runner", "clientType": "cli", "runtimeOwner": "cli", "platform": "linux", "architecture": "x64", "runnerVersion": "1.0.0", "gatewayProtocolVersion": 1, "runnerProtocolVersion": 1, "capabilities": [ "gateway", "mcp", "mail" ], "capabilityHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "maxConcurrency": 1, "status": "active", "hmacGeneration": 1, "lastSeenAt": "2026-08-28T00:05:00.000Z", "lastLeaseAt": "2026-08-28T00:04:00.000Z", "lastUsedAt": "2026-08-28T00:05:00.000Z", "heartbeatExpiresAt": "2026-08-28T00:10:00.000Z", "revokedAt": null } } }, "rotateHumanAgentRunner": { "request": { "newRunnerSecret": "replace-with-a-new-random-runner-secret" }, "response": { "runner": { "runnerRef": "rnr_example", "label": "Local runner", "clientType": "cli", "runtimeOwner": "cli", "platform": "linux", "architecture": "x64", "runnerVersion": "1.0.0", "gatewayProtocolVersion": 1, "runnerProtocolVersion": 1, "capabilities": [ "gateway", "mcp", "mail" ], "capabilityHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "maxConcurrency": 1, "status": "active", "hmacGeneration": 2, "lastSeenAt": "2026-08-28T00:10:00.000Z", "lastLeaseAt": "2026-08-28T00:04:00.000Z", "lastUsedAt": "2026-08-28T00:10:00.000Z", "heartbeatExpiresAt": "2026-08-28T00:10:00.000Z", "revokedAt": null } } }, "revokeHumanAgentRunner": { "request": { "reason": "Revoked by the tenant owner." }, "response": { "runner": { "runnerRef": "rnr_example", "label": "Local runner", "clientType": "cli", "runtimeOwner": "cli", "platform": "linux", "architecture": "x64", "runnerVersion": "1.0.0", "gatewayProtocolVersion": 1, "runnerProtocolVersion": 1, "capabilities": [ "gateway", "mcp", "mail" ], "capabilityHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000", "maxConcurrency": 1, "status": "revoked", "hmacGeneration": 1, "lastSeenAt": "2026-08-28T00:05:00.000Z", "lastLeaseAt": "2026-08-28T00:04:00.000Z", "lastUsedAt": "2026-08-28T00:05:00.000Z", "heartbeatExpiresAt": "2026-08-28T00:10:00.000Z", "revokedAt": "2026-08-28T00:10:00.000Z" } } } }, "negative": { "invalidCredential": { "status": 401, "body": { "error": { "code": "invalid_credential", "message": "The agent credential is invalid.", "retryable": false } } }, "scopeDenied": { "status": 403, "body": { "error": { "code": "scope_denied", "message": "The credential lacks the required scope.", "retryable": false } } }, "idempotencyConflict": { "status": 409, "body": { "error": { "code": "idempotency_conflict", "message": "The idempotency key was reused for a different mutation.", "retryable": false } } }, "runDisabled": { "status": 503, "body": { "error": { "code": "temporarily_disabled", "message": "Agent run execution is not enabled.", "retryable": true, "reason": "run_execution_disabled" } } }, "runnerNotEnrolled": { "status": 409, "body": { "error": { "code": "setup_required", "message": "Enroll and connect a Neotask runner before starting a run.", "retryable": false, "reason": "runner_not_enrolled" } } }, "runnerOffline": { "status": 503, "body": { "error": { "code": "temporarily_disabled", "message": "The enrolled Neotask runner is not currently available.", "retryable": true, "reason": "runner_offline" } } } } } }