> ## 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. # Classify a channel > `internal` writes a mapping row with a null client and routes the room to the Worker's existing core ework — nothing is minted, and it answers **200**, because the row is the whole of the change. `client` binds the room and brings up that pair's ework, so it answers **202** and the agent may still be coming up behind it. Use this rather than a delete to mark a room internal: an unmapped room routes nowhere, which is a different thing. **A `client` classification brings up that Client's ework and spends one of your organization's daily provisioning slots. An `internal` classification mints nothing and spends none.** ## OpenAPI ````yaml /openapi.json patch /api/v1/workers/{id}/channels/{channel} 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}/channels/{channel}: patch: tags: - channels summary: Classify a channel description: >- `internal` writes a mapping row with a null client and routes the room to the Worker's existing core ework — nothing is minted, and it answers **200**, because the row is the whole of the change. `client` binds the room and brings up that pair's ework, so it answers **202** and the agent may still be coming up behind it. Use this rather than a delete to mark a room internal: an unmapped room routes nowhere, which is a different thing. **A `client` classification brings up that Client's ework and spends one of your organization's daily provisioning slots. An `internal` classification mints nothing and spends none.** operationId: classifyChannel 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: channel in: path required: true description: >- A Slack channel id (`C…`/`G…`) or a channel name (`ops`). See *Naming a room* above. schema: type: string description: >- A Slack channel id (`C…`/`G…`) or a channel name (`ops`). See *Naming a room* above. - 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: true content: application/json: schema: type: object properties: kind: type: string enum: - internal - client description: >- `internal` routes the room to the Worker's core ework and mints nothing. `client` binds it to a Client and activates that pair's ework. clientSlug: type: string description: Required when `kind` is `client`. confirm: type: boolean description: >- Required to move a channel already mapped to a different Client. required: - kind additionalProperties: false example: kind: client clientSlug: acme responses: '200': description: Success — `kind` is `internal`, because nothing was started. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ClassifiedChannel' required: - data additionalProperties: false example: data: workerId: 8f1c2d3e-9a4b-4c5d-8e6f-1a2b3c4d5e6f slackChannelId: C0A1B2C3D4E kind: internal clientSlug: null activation: null '202': description: Success. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ClassifiedChannel' required: - data additionalProperties: false example: data: workerId: 8f1c2d3e-9a4b-4c5d-8e6f-1a2b3c4d5e6f slackChannelId: C0A1B2C3D4E kind: client clientSlug: acme activation: succeeded '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' '409': description: '`conflict`' content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: '`quota_exceeded`, `rate_limited`' content: application/json: schema: $ref: '#/components/schemas/QuotaError' '502': description: '`upstream_error`' content: application/json: schema: $ref: '#/components/schemas/Error' security: - orgApiKey: - workers:write components: schemas: ClassifiedChannel: type: object properties: workerId: type: string description: The Worker. slackChannelId: type: string description: The channel that was classified. kind: type: string enum: - internal - client description: What it was classified as. clientSlug: type: - string - 'null' description: The Client, on a `client` classification. Null on `internal`. activation: type: - string - 'null' description: >- What became of that Client's ework. Null on `internal`, which activates nothing. required: - workerId - slackChannelId - kind - clientSlug - activation 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 QuotaError: type: object description: >- A `quota_exceeded` body. `Retry-After` carries the same wait as a header. properties: error: type: object description: The refusal, with the numbers a caller needs to back off correctly. properties: code: type: string enum: - quota_exceeded description: Always `quota_exceeded`. message: type: string description: Prose for a human reading a terminal. limit: type: integer description: The ceiling that was hit, in provisioning runs per rolling day. resetsAt: type: string format: date-time description: >- When the oldest counted run falls out of the window. A lower bound — retry then and you may get a fresher answer. required: - code - message - limit - resetsAt 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.