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

# Write a file

> Send exactly one of `content` (text) or `contentBase64` (bytes) — decoding bytes as text mangles them silently, so sending neither is refused rather than guessed. `changed: false` means the content was already identical and nothing was committed. Every running ework mounting the tier is told, and picks the change up in about twelve seconds.



## OpenAPI

````yaml /openapi.json put /api/v1/eworks/{id}/memory
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/eworks/{id}/memory:
    put:
      tags:
        - memory
      summary: Write a file
      description: >-
        Send exactly one of `content` (text) or `contentBase64` (bytes) —
        decoding bytes as text mangles them silently, so sending neither is
        refused rather than guessed. `changed: false` means the content was
        already identical and nothing was committed. Every running ework
        mounting the tier is told, and picks the change up in about twelve
        seconds.
      operationId: writeMemoryFile
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The ework id. A malformed id answers 404, exactly as another
            organization's well-formed id does.
          schema:
            type: string
            description: >-
              The ework 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: true
        content:
          application/json:
            schema:
              type: object
              properties:
                repoId:
                  type: string
                  description: >-
                    Which tier to write. Must be one this ework can reach, and
                    one of yours.
                path:
                  type: string
                  description: Path from the repository root.
                content:
                  type: string
                  description: >-
                    The text to write. Send exactly one of `content` or
                    `contentBase64`.
                contentBase64:
                  type: string
                  description: Base64 bytes, for a file that is not text.
                expectedSha:
                  type: string
                  description: >-
                    The `sha` you last read. The write is refused as a
                    `conflict` when the file moved since.
              required:
                - repoId
                - path
              additionalProperties: false
            example:
              repoId: 4a5b6c7d-8e9f-4012-8345-67890abcdef1
              path: playbooks/escalation.md
              content: |
                # Escalation

                Page the on-call rota after 30 minutes.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MemoryFileWritten'
                required:
                  - data
                additionalProperties: false
              example:
                data:
                  path: playbooks/escalation.md
                  sha: d7a1f0c9b8e5423a6f10d29c4b8371ee5a0f9c22
                  commitSha: 9b1c0a7e5d34f28a6b09c1d2e3f4a5b6c7d8e9f0
                  changed: true
                  created: false
                  notified: 2
        '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: '`rate_limited`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: '`upstream_error`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - orgApiKey:
            - eworks:write
components:
  schemas:
    MemoryFileWritten:
      type: object
      properties:
        path:
          type: string
          description: The file that was written.
        sha:
          type:
            - string
            - 'null'
          description: Its new blob sha. Pass it as `expectedSha` on the next write.
        commitSha:
          type:
            - string
            - 'null'
          description: The commit that carried it.
        changed:
          type: boolean
          description: >-
            False when the content was already identical, so nothing was
            committed.
        created:
          type: boolean
          description: True when the file did not exist before.
        notified:
          type:
            - integer
            - 'null'
          description: How many running eworks were told. Null when nothing needed telling.
      required:
        - path
        - sha
        - commitSha
        - changed
        - created
        - notified
      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.