# Edit text on a live site - **OpenAPI Version:** `3.2.0` - **API Version:** `3.1.0` - **Contact:** Syndai ## Contents **Operations** - [POST /api/v1/external/coding/repos/{coding\_repository\_id}/text-edits](#scalar-operation-post-apiv1externalcodingreposcoding-repository-idtext-edits) **Schemas** - [SiteTextEditRequest](#scalar-schema-sitetexteditrequest) - [SiteTextEditResponse](#scalar-schema-sitetexteditresponse) - [ProblemDetail](#scalar-schema-problemdetail) - [ExternalErrorCode](#scalar-schema-externalerrorcode) ## Servers - **URL:** `https://api.syndai.ai` ## Authentication - **CustomerApiKey**: HTTP bearer (`API Key`) Customer API key sent as a bearer token ## Tags ### Repositories The repositories connected to your workspace. List them, change a repository's settings, and make or undo a direct text edit on a live site without starting a full run. ## Operations ### Edit text on a live site - **Method:** `POST` - **Path:** `/api/v1/external/coding/repos/{coding_repository_id}/text-edits` - **Operation ID:** `createTextEdit` - **Tags:** Repositories Replace one literal piece of text on a live static site, without starting a coding run. Returns 202 when the edit was committed and 200 when it was already applied. While a run or landing holds the repository it is a 409 `RUN_IN_FLIGHT` naming the blocking `run_id`: wait, then retry. Requires `coding:apps:publish`. **Servers:** [Inherited servers](#scalar-context-global-servers) **Authentication:** [Global authentication](#scalar-context-global-authentication) #### Path parameters - **`coding_repository_id` (required)**: `string`, format: `uuid` #### Query parameters - **`customer_id`**: `string | null`, format: `uuid` #### Request body **Required:** `true` **Content type:** `application/json` [SiteTextEditRequest](#scalar-schema-sitetexteditrequest) **Generated example:** ```json { "after": "", "all": false, "before": "", "page": "", "request_id": "" } ``` #### Responses ##### 202 Request accepted, processing continues off-line **Content type:** `application/json` [SiteTextEditResponse](#scalar-schema-sitetexteditresponse) **Generated example:** ```json { "commit_sha": "", "deployment_id": "", "file": "", "status": "" } ``` ##### 400, 401, 403, 404, 409, 422, 426, 503 - `400` Bad request syntax or unsupported method - `401` Invalid or missing customer API key - `403` Insufficient scope or forbidden customer access - `404` Resource not found - `409` RUN\_IN\_FLIGHT (a run or a landing holds the site; see run\_id) or TEXT\_EDIT\_REFUSED - `422` TEXT\_EDIT\_REFUSED: the new text did not pass content review - `426` CLI\_UPGRADE\_REQUIRED: run npx -y syndai\@latest - `503` TEXT\_EDIT\_REFUSED: the site's source or content review is unreachable; retry **Content type:** `application/problem+json` [ProblemDetail](#scalar-schema-problemdetail) RFC 7807 problem detail returned for public CaaS errors. **Generated example:** ```json { "code": "BUDGET_EXHAUSTED", "detail": null, "existing_run_id": null, "instance": null, "status": 1, "title": "", "type": "about:blank", "additionalProperty": "anything" } ``` ##### 429 Rate limit exceeded **Headers:** - **`Retry-After`** Seconds to wait before retrying the request `integer` **Content type:** `application/problem+json` [ProblemDetail](#scalar-schema-problemdetail) RFC 7807 problem detail returned for public CaaS errors. [Generated example](#scalar-example-3) ##### default Unexpected error **Content type:** `application/problem+json` [ProblemDetail](#scalar-schema-problemdetail) **Generated example:** ```json null ``` ## Schemas ### SiteTextEditRequest **Type:** `object` - **`after` (required)**: `string`, maxLength: `2000` - **`before` (required)**: `string`, minLength: `1`, maxLength: `2000` - **`page` (required)**: `string`, minLength: `1`, maxLength: `2048` - **`request_id` (required)**: `string`, format: `uuid` - **`all`**: `boolean`, default: `false` **Generated example:** ```json { "after": "", "all": false, "before": "", "page": "", "request_id": "" } ``` ### SiteTextEditResponse **Type:** `object` - **`commit_sha` (required)**: `string` - **`file` (required)**: `string` - **`status` (required)**: `string` - **`deployment_id`**: `string | null` **Generated example:** ```json { "commit_sha": "", "deployment_id": "", "file": "", "status": "" } ``` ### ProblemDetail **Type:** `object` RFC 7807 problem detail returned for public CaaS errors. - **`code` (required)**: `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"` Stable error codes surfaced to public CaaS clients. - **`status` (required)**: `integer` - **`title` (required)**: `string` - **`detail`**: `string | null`, default: `null` - **`existing_run_id`**: `string | null`, default: `null` - **`instance`**: `string | null`, default: `null` - **`type`**: `string`, default: `"about:blank"` **Generated example:** ```json { "code": "BUDGET_EXHAUSTED", "detail": null, "existing_run_id": null, "instance": null, "status": 1, "title": "", "type": "about:blank", "additionalProperty": "anything" } ``` ### ExternalErrorCode **Type:** `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "VERSION_NOT_DEPLOYED", "INTERNAL_ERROR"` Stable error codes surfaced to public CaaS clients.