Loading API reference…
/organizations/{organizationId}/discoveryOrganization identifier.
uuidapplication/json
curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/discovery"{}/organizations/{organizationId}/integration-setup/completeIdempotently releases department discovery. No connected integration is required. Company research and ordinary work remain available throughout. The scheduler creates department tasks once deep evidence is retained; this response does not wait for research or provider calls. This is an owner control-plane action, not an agent command.
Organization identifier.
uuidapplication/json
application/json
application/json
curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integration-setup/complete"{}{}{}/organizations/{organizationId}/knowledgeChecks the organization and enabled acting profile. General organization knowledge is shared; department and restricted-source records retain their audience and current integration permissions. Source versions, retention time and validity bound reuse; evidence integrity is not a guarantee of factual correctness. No historical file tree is automatically hydrated.
Organization identifier.
uuidlength <= 2001 <= value <= 50uuidapplication/json
curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/knowledge"{ "success": true, "statusCode": 0, "message": "string", "data": { "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "metadata": { "key": "string", "title": "string", "finding": "string", "applicability": "string", "visibility": "organization", "requiredConnectorKeys": [ "string" ], "sourceVersions": [ { "source": "string", "version": "string", "connectorKey": "string" } ], "evidence": [ { "runId": "78c33d18-170c-44d3-a227-b3194f134f73", "path": "string", "sha256": "string" } ], "validUntil": "2019-08-24T14:15:22Z", "sourceTaskId": "b46343f0-19a2-4701-a438-6edf056909b2", "sourceRunId": "f56f10c5-743d-477c-a57d-2d752452e421", "authorProfileKey": "string", "department": "growth", "retainedAt": "2019-08-24T14:15:22Z" }, "freshness": "current", "supersededBy": "608778cc-35f6-47d1-a540-9bcbfdf24101" } ], "nextCursor": "53a4a333-2825-45a4-80d2-5f430d088f36" }, "meta": {}}/organizations/{organizationId}/knowledge/{knowledgeId}Checks the organization and enabled acting profile. General organization knowledge is shared; department and restricted-source records retain their audience and current integration permissions. Source versions, retention time and validity bound reuse; evidence integrity is not a guarantee of factual correctness. No historical file tree is automatically hydrated.
Organization identifier.
uuiduuidapplication/json
curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/knowledge/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "success": true, "statusCode": 0, "message": "string", "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "metadata": { "key": "string", "title": "string", "finding": "string", "applicability": "string", "visibility": "organization", "requiredConnectorKeys": [ "string" ], "sourceVersions": [ { "source": "string", "version": "string", "connectorKey": "string" } ], "evidence": [ { "runId": "78c33d18-170c-44d3-a227-b3194f134f73", "path": "string", "sha256": "string" } ], "validUntil": "2019-08-24T14:15:22Z", "sourceTaskId": "b46343f0-19a2-4701-a438-6edf056909b2", "sourceRunId": "f56f10c5-743d-477c-a57d-2d752452e421", "authorProfileKey": "string", "department": "growth", "retainedAt": "2019-08-24T14:15:22Z" }, "freshness": "current", "supersededBy": "608778cc-35f6-47d1-a540-9bcbfdf24101", "procedure": [ "string" ] }, "meta": {}}/organizations/{organizationId}/learningOperator and Chat read all enabled learning profiles. Departments read organization and own-profile conclusions. Learned conclusions do not grant connector or mutation authority. Missing memory is null. Disabled profiles are excluded.
Organization identifier.
uuidapplication/json
curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/learning"{ "success": true, "statusCode": 0, "message": "string", "data": [ { "profileKey": "string", "profileName": "string", "department": "growth", "memory": { "kind": "profile_memory", "profileKey": "string", "revision": 1, "watermarkTaskId": "023859b5-2793-427e-a028-3a460435c0b3", "lessons": [ { "key": "string", "lesson": "string", "sourceTaskIds": [ "e4637db2-e2d0-4ad1-a6b6-4e31232d78bc" ], "evidence": [ { "runId": "78c33d18-170c-44d3-a227-b3194f134f73", "path": "string", "sha256": "string" } ], "humanInboxItemIds": [ "b2732a79-0f5e-40b3-bc7b-2f46370ece85" ], "createdAt": "2019-08-24T14:15:22Z", "supersedes": "string", "origin": "verified_learning" } ], "suggestions": [ { "key": "string", "title": "string", "rationale": "string", "prompt": "string", "evidence": [ { "runId": "78c33d18-170c-44d3-a227-b3194f134f73", "path": "string", "sha256": "string" } ] } ], "lastLearnedAt": "2019-08-24T14:15:22Z", "cycleStartedAt": "2019-08-24T14:15:22Z", "sourceTaskId": "b46343f0-19a2-4701-a438-6edf056909b2" }, "inputs": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "profileKey": "string", "sourceTaskId": "b46343f0-19a2-4701-a438-6edf056909b2", "status": "open", "question": "string", "presentation": { "title": "string", "summary": "string", "businessImpact": "string", "recommendation": "string", "options": [ { "id": "string", "label": "string", "description": "string" }, { "id": "string", "label": "string", "description": "string" } ], "recommendedOptionId": "string" }, "response": "string", "resolvedAt": "2019-08-24T14:15:22Z" } ] } ], "meta": {}}/organizations/{organizationId}/learning/{profileKey}Operator and Chat read all enabled learning profiles. Departments read organization and own-profile conclusions. Learned conclusions do not grant connector or mutation authority. Missing memory is null. Disabled profiles are excluded.
Organization identifier.
uuid^[a-z0-9]+(?:-[a-z0-9]+)*$1 <= length <= 100application/json
curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/learning/string"{ "success": true, "statusCode": 0, "message": "string", "data": { "profileKey": "string", "profileName": "string", "department": "growth", "memory": { "kind": "profile_memory", "profileKey": "string", "revision": 1, "watermarkTaskId": "023859b5-2793-427e-a028-3a460435c0b3", "lessons": [ { "key": "string", "lesson": "string", "sourceTaskIds": [ "e4637db2-e2d0-4ad1-a6b6-4e31232d78bc" ], "evidence": [ { "runId": "78c33d18-170c-44d3-a227-b3194f134f73", "path": "string", "sha256": "string" } ], "humanInboxItemIds": [ "b2732a79-0f5e-40b3-bc7b-2f46370ece85" ], "createdAt": "2019-08-24T14:15:22Z", "supersedes": "string", "origin": "verified_learning" } ], "suggestions": [ { "key": "string", "title": "string", "rationale": "string", "prompt": "string", "evidence": [ { "runId": "78c33d18-170c-44d3-a227-b3194f134f73", "path": "string", "sha256": "string" } ] } ], "lastLearnedAt": "2019-08-24T14:15:22Z", "cycleStartedAt": "2019-08-24T14:15:22Z", "sourceTaskId": "b46343f0-19a2-4701-a438-6edf056909b2" }, "inputs": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "profileKey": "string", "sourceTaskId": "b46343f0-19a2-4701-a438-6edf056909b2", "status": "open", "question": "string", "presentation": { "title": "string", "summary": "string", "businessImpact": "string", "recommendation": "string", "options": [ { "id": "string", "label": "string", "description": "string" }, { "id": "string", "label": "string", "description": "string" } ], "recommendedOptionId": "string" }, "response": "string", "resolvedAt": "2019-08-24T14:15:22Z" } ] }, "meta": {}}/organizations/{organizationId}/learning/{profileKey}/refreshReturns the active root learning task or creates a pending one for the scheduler. Concurrent scheduled and manual requests coalesce under a database lock. Operator and Chat may refresh enabled profiles; a department may refresh only itself. Verification and stale executions cannot refresh. No suggestions execute and no run budget resets.
Organization identifier.
uuid^[a-z0-9]+(?:-[a-z0-9]+)*$1 <= length <= 100application/json
curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/learning/string/refresh"{ "success": true, "statusCode": 0, "message": "string", "data": { "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8", "identifier": "string", "status": "pending" }, "meta": {}}/organizationsCursor returned by the previous list call.
uuidMaximum number of organizations to return.
Value in
Value in
application/json
application/json
curl -X GET "https://example.com/organizations"{ "success": true, "statusCode": 200, "message": "Organizations listed.", "data": [ { "id": "7d4a6f1d-ff64-4a4f-9e8d-937bfaa0d2f1", "slug": "acme", "name": "Acme", "status": "active", "onboardedAt": "2026-01-01T00:00:00.000Z", "workDispatchStoppedAt": null, "rootUri": "memory://organizations/acme", "authorizationEpoch": 1, "config": { "timezone": "UTC", "departments": { "growth": { "enabled": true }, "engineering": { "enabled": true }, "support": { "enabled": true } }, "limits": { "maxTaskDepth": 4, "maxPlanOperations": 25, "maxInitiativeDescendants": 100 }, "storageRootUri": "memory://organizations/acme" }, "constraints": { "allowedIntegrations": [], "blockedDomains": [], "approvalRequiredForRisk": [ "external", "high" ] }, "createdAt": "2026-01-01T00:00:00.000Z", "updatedAt": "2026-01-01T00:00:00.000Z" } ], "pagination": { "cursor": null, "limit": 50, "nextCursor": null, "previousCursor": null, "hasNextPage": false, "hasPreviousPage": false }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z" }}{ "success": false, "statusCode": 400, "message": "Validation failed.", "error": { "code": "validation_failed", "issues": [ { "path": "organizationId", "message": "Must be a valid UUID.", "code": "invalid_format" } ] }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z", "traceId": "4bf92f3577b34da6a3ce929d0e0e4736", "requestId": "4bf92f3577b34da6a3ce929d0e0e4736" }}/organizationsAtomically creates an active company, five enabled profiles, normal chat, disabled catalog integrations, initial Context and background research intentions. No public research or third-party connection check runs in this request. Retain the body and key across uncertain retries.
A fresh UUID for a creation attempt. Reuse only with the same normalized company details.
uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/organizations" \ -H "Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "website": "string", "timezone": "string", "defaultCurrency": "string" }'/organizations/{organizationId}Organization identifier.
uuidapplication/json
application/json
application/json
curl -X GET "https://example.com/organizations/7d4a6f1d-ff64-4a4f-9e8d-937bfaa0d2f1"{ "success": true, "statusCode": 200, "message": "Organization found.", "data": { "id": "7d4a6f1d-ff64-4a4f-9e8d-937bfaa0d2f1", "slug": "acme", "name": "Acme", "status": "active", "onboardedAt": "2026-01-01T00:00:00.000Z", "workDispatchStoppedAt": null, "rootUri": "memory://organizations/acme", "authorizationEpoch": 1, "config": { "timezone": "UTC", "departments": { "growth": { "enabled": true }, "engineering": { "enabled": true }, "support": { "enabled": true } }, "limits": { "maxTaskDepth": 4, "maxPlanOperations": 25, "maxInitiativeDescendants": 100 }, "storageRootUri": "memory://organizations/acme" }, "constraints": { "allowedIntegrations": [], "blockedDomains": [], "approvalRequiredForRisk": [ "external", "high" ] }, "createdAt": "2026-01-01T00:00:00.000Z", "updatedAt": "2026-01-01T00:00:00.000Z" }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z" }}{ "success": false, "statusCode": 400, "message": "Validation failed.", "error": { "code": "validation_failed", "issues": [ { "path": "organizationId", "message": "Must be a valid UUID.", "code": "invalid_format" } ] }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z", "traceId": "4bf92f3577b34da6a3ce929d0e0e4736", "requestId": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "success": false, "statusCode": 404, "message": "Organization not found.", "error": { "code": "organization_not_found" }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z" }}/organizations/{organizationId}Organization identifier.
uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
curl -X PATCH "https://example.com/organizations/7d4a6f1d-ff64-4a4f-9e8d-937bfaa0d2f1" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Global" }'{ "success": true, "statusCode": 200, "message": "Organization updated.", "data": { "id": "7d4a6f1d-ff64-4a4f-9e8d-937bfaa0d2f1", "slug": "acme", "name": "Acme Global", "status": "active", "onboardedAt": "2026-01-01T00:00:00.000Z", "workDispatchStoppedAt": null, "rootUri": "memory://organizations/acme", "authorizationEpoch": 1, "config": { "timezone": "UTC", "departments": { "growth": { "enabled": true }, "engineering": { "enabled": true }, "support": { "enabled": true } }, "limits": { "maxTaskDepth": 4, "maxPlanOperations": 25, "maxInitiativeDescendants": 100 }, "storageRootUri": "memory://organizations/acme" }, "constraints": { "allowedIntegrations": [], "blockedDomains": [], "approvalRequiredForRisk": [ "external", "high" ] }, "createdAt": "2026-01-01T00:00:00.000Z", "updatedAt": "2026-01-01T00:00:00.000Z" }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z" }}{ "success": false, "statusCode": 400, "message": "Validation failed.", "error": { "code": "validation_failed", "issues": [ { "path": "organizationId", "message": "Must be a valid UUID.", "code": "invalid_format" } ] }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z", "traceId": "4bf92f3577b34da6a3ce929d0e0e4736", "requestId": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "success": false, "statusCode": 404, "message": "Organization not found.", "error": { "code": "organization_not_found" }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z" }}/organizations/{organizationId}Organization identifier.
uuidapplication/json
application/json
application/json
curl -X DELETE "https://example.com/organizations/7d4a6f1d-ff64-4a4f-9e8d-937bfaa0d2f1"{ "success": true, "statusCode": 200, "message": "Organization deleted.", "data": { "id": "7d4a6f1d-ff64-4a4f-9e8d-937bfaa0d2f1", "slug": "acme", "name": "Acme", "status": "active", "onboardedAt": "2026-01-01T00:00:00.000Z", "workDispatchStoppedAt": null, "rootUri": "memory://organizations/acme", "authorizationEpoch": 1, "config": { "timezone": "UTC", "departments": { "growth": { "enabled": true }, "engineering": { "enabled": true }, "support": { "enabled": true } }, "limits": { "maxTaskDepth": 4, "maxPlanOperations": 25, "maxInitiativeDescendants": 100 }, "storageRootUri": "memory://organizations/acme" }, "constraints": { "allowedIntegrations": [], "blockedDomains": [], "approvalRequiredForRisk": [ "external", "high" ] }, "createdAt": "2026-01-01T00:00:00.000Z", "updatedAt": "2026-01-01T00:00:00.000Z" }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z" }}{ "success": false, "statusCode": 400, "message": "Validation failed.", "error": { "code": "validation_failed", "issues": [ { "path": "organizationId", "message": "Must be a valid UUID.", "code": "invalid_format" } ] }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z", "traceId": "4bf92f3577b34da6a3ce929d0e0e4736", "requestId": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "success": false, "statusCode": 404, "message": "Organization not found.", "error": { "code": "organization_not_found" }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z" }}/organizations/{organizationId}/iconDiscovers a display icon from the organization's saved onboarding website. Reads declared icons, Apple touch icons and web manifests, then common favicon paths. Supports SVG, PNG, WebP, AVIF, JPEG, GIF, BMP and ICO independently of URL extensions. Public HTTPS requests are bounded to eight seconds overall, three redirects per asset and 256 KiB per image. Successful images are privately cacheable for one hour; unavailable icons return 204 and are cacheable for one minute. No configuration is changed. The UI retains its building icon when no image loads. SVG responses use a restrictive sandbox content security policy. HEAD returns the same headers without a body.
Organization identifier.
uuidapplication/json
application/json
curl -X GET "https://example.com/organizations/7d4a6f1d-ff64-4a4f-9e8d-937bfaa0d2f1/icon""string"{ "success": false, "statusCode": 400, "message": "Validation failed.", "error": { "code": "validation_failed", "issues": [ { "path": "organizationId", "message": "Must be a valid UUID.", "code": "invalid_format" } ] }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z", "traceId": "4bf92f3577b34da6a3ce929d0e0e4736", "requestId": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "success": false, "statusCode": 404, "message": "Organization not found.", "error": { "code": "organization_not_found" }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z" }}/organizations/{organizationId}/iconDiscovers a display icon from the organization's saved onboarding website. Reads declared icons, Apple touch icons and web manifests, then common favicon paths. Supports SVG, PNG, WebP, AVIF, JPEG, GIF, BMP and ICO independently of URL extensions. Public HTTPS requests are bounded to eight seconds overall, three redirects per asset and 256 KiB per image. Successful images are privately cacheable for one hour; unavailable icons return 204 and are cacheable for one minute. No configuration is changed. The UI retains its building icon when no image loads. SVG responses use a restrictive sandbox content security policy. HEAD returns the same headers without a body.
Organization identifier.
uuidapplication/json
application/json
curl -X HEAD "https://example.com/organizations/7d4a6f1d-ff64-4a4f-9e8d-937bfaa0d2f1/icon""string"{ "success": false, "statusCode": 400, "message": "Validation failed.", "error": { "code": "validation_failed", "issues": [ { "path": "organizationId", "message": "Must be a valid UUID.", "code": "invalid_format" } ] }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z", "traceId": "4bf92f3577b34da6a3ce929d0e0e4736", "requestId": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "success": false, "statusCode": 404, "message": "Organization not found.", "error": { "code": "organization_not_found" }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z" }}/organizations/{organizationId}/work-dispatchStopping preserves schedules, tasks, and run requests while suppressing new worker wakeups. Work already published or running continues. Resuming republishes due durable requests.
Organization identifier.
uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
curl -X PATCH "https://example.com/organizations/7d4a6f1d-ff64-4a4f-9e8d-937bfaa0d2f1/work-dispatch" \ -H "Content-Type: application/json" \ -d '{ "stopped": true }'{ "success": true, "statusCode": 200, "message": "Work dispatch updated.", "data": { "organization": { "id": "7d4a6f1d-ff64-4a4f-9e8d-937bfaa0d2f1", "slug": "acme", "name": "Acme", "status": "active", "onboardedAt": "2026-01-01T00:00:00.000Z", "workDispatchStoppedAt": "2026-08-18T12:00:00.000Z", "rootUri": "memory://organizations/acme", "authorizationEpoch": 1, "config": { "timezone": "UTC", "departments": { "growth": { "enabled": true }, "engineering": { "enabled": true }, "support": { "enabled": true } }, "limits": { "maxTaskDepth": 4, "maxPlanOperations": 25, "maxInitiativeDescendants": 100 }, "storageRootUri": "memory://organizations/acme" }, "constraints": { "allowedIntegrations": [], "blockedDomains": [], "approvalRequiredForRisk": [ "external", "high" ] }, "createdAt": "2026-01-01T00:00:00.000Z", "updatedAt": "2026-01-01T00:00:00.000Z" }, "publishedRunRequests": 0 }, "meta": { "timestamp": "2026-08-18T12:00:00.000Z" }}{ "success": false, "statusCode": 400, "message": "Validation failed.", "error": { "code": "validation_failed", "issues": [ { "path": "organizationId", "message": "Must be a valid UUID.", "code": "invalid_format" } ] }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z", "traceId": "4bf92f3577b34da6a3ce929d0e0e4736", "requestId": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "success": false, "statusCode": 404, "message": "Organization not found.", "error": { "code": "organization_not_found" }, "meta": { "timestamp": "2026-01-01T00:00:00.000Z" }}2 <= length <= 120Public HTTPS company website. Bare domains are normalized to HTTPS without fetching the URL.
length <= 2048Supported ISO 4217 currency code.
2 <= length <= 120Public HTTPS URL or bare domain. Host changes start a new research generation.
Value in