> ## Documentation Index > Fetch the complete documentation index at: https://docs.ergoly.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update a worker > These columns are what the agent's identity file is composed from, so editing `displayName` changes who the agent says it is from its next turn. That is why editing the file by hand is refused and this is not. `roleTitle` and `description` take `null` to clear them. A change to any of the three is also pushed to the Worker's installed Slack app, with no re-install: Slack shows the new name within a couple of minutes, punctuation in it becomes spaces, and @mentions show the new name. `slackApp` says whether that push happened; the saved fields stand either way. ## OpenAPI ````yaml /openapi.json patch /api/v1/workers/{id} openapi: 3.1.0 info: title: Ergoly platform API version: 1.0.0 description: >- Read and change one organization's own Ergoly environment. Every route is scoped to the organization the presented credential resolves to; there is no parameter that widens it. The human-readable reference is served from the same namespace at `/api/v1/docs`, behind the same credential. The namespace's front door is `GET /api/v1`, and it is deliberately absent from `paths` below. It answers without a credential — what this API is, how an organization admin mints a key, and where the reference lives — so it is the way in to this contract rather than a part of it: it has no scope, takes no parameters, and there is nothing about it for a generated client to call. Every `unauthorized` refusal carries that same URL as `error.docs`. servers: - url: https://control.ergoly.ai security: - orgApiKey: [] tags: - name: auth description: How to present a key, what it is scoped to, and what a 401 means. - name: organization description: Which organization your credential resolves to. - name: workers description: The Slack apps and bot identities in your organization. - name: eworks description: The runtime instances under a Worker — one core, one per bound Client. - name: clients description: The customers a Worker can be scoped to, and how to bind one. - name: channels description: Which Slack rooms a Worker answers in, and who it answers as. - name: tasks description: >- Tasks handed between Workers and people, scheduled jobs, their targets, and their run history. - name: jobs description: How a provisioning run is going — the other half of every 202. - name: memory description: Read and write the memory tiers an ework mounts. - name: connections description: The credentials your agents use, and the hosts they are injected on. - name: webhooks description: Inbound URLs an outside system can POST to, each of which starts a turn. - name: activity description: Your organization's audit feed. - name: usage description: Cost, turn outcomes and a per-day pulse over a window you choose. - name: errors description: The closed set of refusal codes, and what to do about each. paths: /api/v1/workers/{id}: patch: tags: - workers summary: Update a worker description: >- These columns are what the agent's identity file is composed from, so editing `displayName` changes who the agent says it is from its next turn. That is why editing the file by hand is refused and this is not. `roleTitle` and `description` take `null` to clear them. A change to any of the three is also pushed to the Worker's installed Slack app, with no re-install: Slack shows the new name within a couple of minutes, punctuation in it becomes spaces, and @mentions show the new name. `slackApp` says whether that push happened; the saved fields stand either way. operationId: updateWorker parameters: - name: id in: path required: true description: >- The Worker id. A malformed id answers 404, exactly as another organization's well-formed id does. schema: type: string description: >- The Worker id. A malformed id answers 404, exactly as another organization's well-formed id does. - name: Idempotency-Key in: header required: false description: >- Any unique string. A retry under the same key is answered from the first attempt's record, with `X-Idempotent-Replay: true`. The same key with a different body is a conflict. schema: type: string description: Any unique string. requestBody: required: false content: application/json: schema: type: object properties: displayName: type: string description: The name the agent answers to. roleTitle: type: - string - 'null' description: The role it presents as. `null` clears it. description: type: - string - 'null' description: What it is for. `null` clears it. required: [] additionalProperties: false example: roleTitle: Support lead responses: '200': description: Success. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/UpdatedWorker' required: - data additionalProperties: false example: data: workerId: 8f1c2d3e-9a4b-4c5d-8e6f-1a2b3c4d5e6f slug: rowan slackApp: status: updated reason: null '400': description: '`invalid_request`' content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: '`unauthorized`' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: '`not_found`' content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: '`rate_limited`' content: application/json: schema: $ref: '#/components/schemas/Error' security: - orgApiKey: - workers:write components: schemas: UpdatedWorker: type: object properties: workerId: type: string description: The Worker that changed. slug: type: string description: Its slug. slackApp: type: object description: >- What happened to the Worker's installed Slack app. The saved fields stand whatever it says. properties: status: type: string enum: - updated - unchanged - not_updated description: >- `updated`: the Slack app now carries the new details. `unchanged`: nothing the app shows changed, so it was not touched. `not_updated`: see `reason`. reason: type: - string - 'null' description: >- Why the Slack app was not updated, when `status` is `not_updated`; otherwise null. One of: `no_app` (This Worker has no Slack app yet; its provisioning run creates one from the saved details.) `not_active` (This Worker is not active (it is provisioning, awaiting an install, or failed), so its Slack app was not updated; its next provisioning run pushes the change.) `events_url_not_foreman` (This Worker's Slack events URL is not registered with foreman right now, so updating its Slack app would stop Slack reaching it. Re-provision the Worker to apply the change.) `slack_token_unusable` (This organization's Slack connection could not be used to update the app. An admin may need to reconnect Slack in the organization's settings.) `slack_refused` (Slack refused the update. Usually the person who connected this organization's Slack is not a collaborator on this Worker's app, or the change needs a workspace admin to re-install it.) required: - status - reason additionalProperties: false required: - workerId - slug - slackApp additionalProperties: false Error: type: object description: The one error shape. Every refusal in this namespace has it. properties: error: type: object description: The refusal. properties: code: type: string enum: - unauthorized - not_found - invalid_request - conflict - quota_exceeded - rate_limited - upstream_error - gone description: The machine-stable half. Branch on this, never on `message`. message: type: string description: Prose for a human reading a terminal. docs: type: string description: >- Where to learn how to authenticate. Present on `unauthorized` and on nothing else — it is the one refusal a caller can reach with no credential at all, so it is the one that has to say where the way in is. required: - code - message additionalProperties: false required: - error additionalProperties: false securitySchemes: orgApiKey: type: http scheme: bearer description: >- An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, `:`, where the resource is the first path segment after `/api/v1/`; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.