> ## 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.

# List a worker's copies

> One core ework plus one per bound Client. An empty list means this Worker has no eworks; a 404 means no such Worker for this credential. The two are kept apart deliberately — deriving the first from the second would report another tenant's Worker as one of yours that happens to be empty.



## OpenAPI

````yaml /openapi.json get /api/v1/workers/{id}/eworks
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}/eworks:
    get:
      tags:
        - eworks
      summary: List a worker's copies
      description: >-
        One core ework plus one per bound Client. An empty list means this
        Worker has no eworks; a 404 means no such Worker for this credential.
        The two are kept apart deliberately — deriving the first from the second
        would report another tenant's Worker as one of yours that happens to be
        empty.
      operationId: listWorkerEworks
      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: clientId
          in: query
          required: false
          description: >-
            Narrow to one Client. Rows that belong to no Client — a core-tier
            ework, a room marked internal, a core-tier task — are excluded,
            because they are not that Client's. A malformed id is a 400; a
            well-formed id naming another organization's Client answers an empty
            list.
          schema:
            type: string
            description: >-
              Narrow to one Client. Rows that belong to no Client — a core-tier
              ework, a room marked internal, a core-tier task — are excluded,
              because they are not that Client's. A malformed id is a 400; a
              well-formed id naming another organization's Client answers an
              empty list.
        - name: limit
          in: query
          required: false
          description: >-
            Page size. Defaults to 50, clamped at 200. A value that is not a
            positive integer is a 400.
          schema:
            type: integer
            description: >-
              Page size. Defaults to 50, clamped at 200. A value that is not a
              positive integer is a 400.
        - name: cursor
          in: query
          required: false
          description: >-
            Opaque keyset cursor from the previous page's `page.nextCursor`. A
            cursor this API did not issue is a 400, never a silent page one.
          schema:
            type: string
            description: >-
              Opaque keyset cursor from the previous page's `page.nextCursor`. A
              cursor this API did not issue is a 400, never a silent page one.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Ework'
                    description: The page.
                  page:
                    $ref: '#/components/schemas/PageInfo'
                required:
                  - data
                  - page
                additionalProperties: false
              example:
                data:
                  - id: 3b7e1c44-2d59-4f0a-9c81-5e6d7a8b9c01
                    organizationId: 0d4c9f2e-4b8a-4a5b-9e21-6f9c2a1b7d30
                    workerId: 8f1c2d3e-9a4b-4c5d-8e6f-1a2b3c4d5e6f
                    clientId: c1a2b3c4-d5e6-4f70-8912-3a4b5c6d7e8f
                    tier: client
                    status: active
                    sandboxClass: container
                    daytonaSandboxId: sbx_9f21c4a8
                    lettaAgentId: agent-7c1d0b3e
                    snapshotName: ework-3f9a1c7d
                    sleepingAt: '2026-03-04T11:02:10.000Z'
                    wakingAt: null
                    lastActivityAt: '2026-03-04T10:57:03.000Z'
                    lastWakeAt: '2026-03-04T08:41:55.000Z'
                    createdAt: '2026-02-11T14:09:40.000Z'
                    updatedAt: '2026-03-04T11:02:10.000Z'
                page:
                  limit: 50
                  hasMore: true
                  nextCursor: >-
                    MjAyNi0wMy0wNFQwOToxNDowMi4wMDBafDhmMWMyZDNlLTlhNGItNGM1ZC04ZTZmLTFhMmIzYzRkNWU2Zg
        '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:read
components:
  schemas:
    Ework:
      type: object
      description: 'One runtime instance: a sandbox and the agent inside it.'
      properties:
        id:
          type: string
          description: The ework id.
        organizationId:
          type: string
          description: Always your own organization.
        workerId:
          type: string
          description: The Worker this runtime belongs to.
        clientId:
          type:
            - string
            - 'null'
          description: The Client it serves. Null on a core-tier ework.
        tier:
          type: string
          enum:
            - core
            - client
          description: '`core` serves the Worker; `client` serves one Client.'
        status:
          type: string
          description: >-
            `draft` | `active` | `stopped` | `failed`. Only `active` takes
            traffic.
        sandboxClass:
          type: string
          enum:
            - container
            - linux-vm
          description: Which sandbox lineage it runs on.
        daytonaSandboxId:
          type:
            - string
            - 'null'
          description: Opaque sandbox id, useful to quote in a support thread.
        lettaAgentId:
          type:
            - string
            - 'null'
          description: Opaque agent id, same purpose.
        snapshotName:
          type:
            - string
            - 'null'
          description: The snapshot this sandbox was provisioned from.
        sleepingAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Set means the sandbox is stopped. A turn wakes it; nothing else need
            be done.
        wakingAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Set means a wake is running right now.
        lastActivityAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Last time a turn touched it — the idle clock.
        lastWakeAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Last completed wake.
        createdAt:
          type: string
          format: date-time
          description: When the row was written.
        updatedAt:
          type: string
          format: date-time
          description: When it last changed.
      required:
        - id
        - organizationId
        - workerId
        - clientId
        - tier
        - status
        - sandboxClass
        - daytonaSandboxId
        - lettaAgentId
        - snapshotName
        - sleepingAt
        - wakingAt
        - lastActivityAt
        - lastWakeAt
        - createdAt
        - updatedAt
      additionalProperties: false
    PageInfo:
      type: object
      description: Present on every list, even when there is nothing more to fetch.
      properties:
        limit:
          type: integer
          description: The page size actually applied, after clamping.
        hasMore:
          type: boolean
          description: True when another page exists.
        nextCursor:
          type:
            - string
            - 'null'
          description: >-
            Feed back as `?cursor=`. Null when `hasMore` is false — and always
            null on a list that takes no `cursor` parameter, which ranks its
            rows rather than paging them and says so on its own page. Narrow
            that list's `query` instead.
      required:
        - limit
        - hasMore
        - nextCursor
      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,
        `<resource>:<read|write>`, 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.