> ## Documentation Index > Fetch the complete documentation index at: https://docs.parable.work/llms.txt > Use this file to discover all available pages before exploring further. # Rename a Parable Artifact > Renames a file of the Parable. Only the part before the extension changes, because the type depends on the extension. A Pane that names the file by id keeps working. > **[Rename a Parable Artifact](https://docs.parable.work/protocols/_generated/mcp/web-api/parable-artifacts#tool-rename_parable_artifact)** > > `rename_parable_artifact` ## OpenAPI ````yaml /protocols/_generated/openapi/web-api.json post /api/parable/authoring/primaries/{rootRefId}/artifacts/{artifactId}/actions/rename openapi: 3.0.3 info: description: >- Use the Workspace API to work with artifacts, connectors, Parables, and account resources. title: Workspace API version: v2026.10.27.1 servers: [] security: [] paths: /api/parable/authoring/primaries/{rootRefId}/artifacts/{artifactId}/actions/rename: post: tags: - Parable artifacts summary: Rename a Parable Artifact description: >- Renames a file of the Parable. Only the part before the extension changes, because the type depends on the extension. A Pane that names the file by id keeps working. operationId: ParableArtifactsRenameParableArtifactHandler parameters: - description: >- Workspace slug. Overrides subdomain-based workspace resolution when provided. in: header name: X-Tenant required: false schema: example: acme type: string - description: Optional request correlation ID echoed back in the response. in: header name: X-Request-ID required: false schema: example: 550e8400-e29b-41d4-a716-446655440000 format: uuid type: string - description: rootRefId parameter in: path name: rootRefId required: true schema: description: UUID v4 with automatic base62 encoding for client-facing APIs type: string - description: artifactId parameter in: path name: artifactId required: true schema: description: UUID v4 with automatic base62 encoding for client-facing APIs type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RenameParableArtifactInput' required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/ArtifactInfo' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' required: - data - meta type: object description: Successful response headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' '400': content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: >- The request is not valid. `detail` says why. A value that breaks a field rule gives the code `WA-VL-001` and an `errors` member that names each field. headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' '401': content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: The token is missing, malformed, revoked, or expired. headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' '403': content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: >- The token cannot make this request. For example, the roles of its owner do not allow the operation. headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' '404': content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: The resource that the path names was not found. headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' '500': content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' description: The request failed on the server. headers: X-Request-ID: $ref: '#/components/headers/X-Request-ID' security: - bearerAuth: [] x-codeSamples: - label: TypeScript SDK lang: typescript source: >- import { WebApiSDK } from "@parable-platform/web-api-sdk"; import type { RenameParableArtifactInput } from "@parable-platform/web-api-types"; const sdk = new WebApiSDK({ baseUrl: process.env.PARABLE_API_URL!, auth: { token: process.env.PARABLE_API_TOKEN! }, requestInterceptor: (config) => ({ ...config, headers: { ...config.headers, "X-Tenant": process.env.PARABLE_WORKSPACE! }, }), }); const input: RenameParableArtifactInput = JSON.parse(`{ "fileName": "example" }`); const result = await sdk.parableArtifacts.renameParableArtifact( "example", "example", input ); - label: Python SDK lang: python source: >- import json import os from parable_types_web_api import RenameParableArtifactInput from parable_web_api_sdk import ClientConfig, WebApiSDK sdk = WebApiSDK( ClientConfig( base_url=os.environ["PARABLE_API_URL"], auth_token=os.environ["PARABLE_API_TOKEN"], default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]}, ) ) input_data = RenameParableArtifactInput.model_validate( json.loads("{\"fileName\":\"example\"}"), ) result = sdk.parable_artifacts.rename_parable_artifact('example', 'example', input_data) - label: Rust SDK lang: rust source: >- use parable_web_api_sdk::{types, ClientConfig, RequestOptions, WebApiSdk}; let sdk = WebApiSdk::new(ClientConfig::with_base_url( std::env::var("PARABLE_API_URL")?, Some(std::env::var("PARABLE_API_TOKEN")?), None, ))?; let options = RequestOptions::with_header("X-Tenant", std::env::var("PARABLE_WORKSPACE")?, None, None); let input: types::RenameParableArtifactInput = serde_json::from_value( serde_json::json!({ "fileName": "example" }), )?; let result = sdk.parable_artifacts.rename_parable_artifact( serde_json::from_value(serde_json::json!("example"))?, serde_json::from_value(serde_json::json!("example"))?, input, Some(&options) ).await?; - label: Go SDK lang: go source: "sdk, err := webapisdk.New(webapisdk.SDKConfig{\n\tBaseURL: os.Getenv(\"PARABLE_API_URL\"),\n\tAuth: &webapisdk.AuthConfig{Token: os.Getenv(\"PARABLE_API_TOKEN\")},\n\tRequestInterceptor: func(ctx context.Context, req *http.Request) error {\n\t\treq.Header.Set(\"X-Tenant\", os.Getenv(\"PARABLE_WORKSPACE\"))\n\t\treturn nil\n\t},\n})\nif err != nil {\n\treturn err\n}\n\nvar input webapitypes.RenameParableArtifactInput\nif err := json.Unmarshal([]byte(`{\"fileName\":\"example\"}`), &input); err != nil {\n\treturn err\n}\nresult, err := sdk.ParableArtifactsNamespace.RenameParableArtifact(ctx, \"example\", \"example\", input)" components: schemas: RenameParableArtifactInput: additionalProperties: false properties: fileName: description: 'The new name. The extension stays: only the part before it changes.' minLength: 1 type: string required: - fileName type: object ArtifactInfo: description: Artifact metadata for customer display. properties: analysisWork: oneOf: - $ref: '#/components/schemas/ArtifactWorkStatus' - enum: - null nullable: true type: object attributedTapId: description: >- ID of the provider connection that was derived from this artifact, if any. Populated by a query-time lookup from `tenant_connector_tap.artifact_id` rather than a stored column (the inverse FK is intentionally one-way; see Phase 1 cycle-breaking decision). Null until the artifact has been processed and its derived tap has been created. nullable: true pattern: >- ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ type: string createdAt: description: >- ISO8601 datetime string. Epoch wire values keep this scalar and declare x-temporal-format (unix, unix_millis, unix_micros, unix_nanos) on the property; the unit is never guessed from digit count. format: date-time type: string createdBy: description: UUID v4 string as base62 pattern: ^[0-9A-Za-z]{1,22}$ type: string dataSchema: description: Current persisted schema. Null until a schema is generated or saved. nullable: true type: object deletedAt: description: >- Null while listed. A deleted file remains available to saved references. format: date-time nullable: true type: string familyName: description: >- A font's family display name, which a person may rename. The CSS name is media.font.family and never changes. nullable: true type: string fileName: type: string fileSize: description: File size in bytes (non-negative, BIGINT-backed) format: int64 maximum: 9007199254740991 minimum: 0 type: integer fileType: $ref: '#/components/schemas/ArtifactTypeEnum' id: description: UUID v4 with automatic base62 encoding for client-facing APIs pattern: >- ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ type: string kind: $ref: '#/components/schemas/ArtifactKindEnum' description: What the file is for a person, from the allowlist. madeByPonder: description: Ponder made the file; uploadedBy is the person whose turn made it. type: boolean media: description: |- What the worker read from the file: size, duration, font names. Null until the worker checks the file, and for Workspace Artifacts. oneOf: - $ref: '#/components/schemas/ArtifactMedia' - enum: - null nullable: true type: object parableId: description: The Parable the file belongs to. Null for a Workspace Artifact. nullable: true pattern: >- ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ type: string path: description: >- Virtual-folder path for this artifact, dot-separated ltree. NULL means the artifact lives at the workspace root. maxLength: 2048 nullable: true pattern: ^[A-Za-z_][A-Za-z0-9_]*(?:\.[A-Za-z_][A-Za-z0-9_]*)*$ type: string publishWork: oneOf: - $ref: '#/components/schemas/ArtifactWorkStatus' - enum: - null nullable: true type: object rowCount: description: Rows in a data file, when the format states it. format: int64 maximum: 9007199254740991 minimum: -9007199254740991 nullable: true type: integer schemaInferenceStatus: $ref: '#/components/schemas/ArtifactSchemaInferenceStatusEnum' updatedAt: description: >- ISO8601 datetime string. Epoch wire values keep this scalar and declare x-temporal-format (unix, unix_millis, unix_micros, unix_nanos) on the property; the unit is never guessed from digit count. format: date-time type: string updatedBy: description: UUID v4 string as base62 pattern: ^[0-9A-Za-z]{1,22}$ type: string uploadExpiresAt: description: >- While a Parable file has not arrived (PENDING): when its signed upload URL stops working. After that, no new upload of its bytes can start, so a file that is still PENDING with no upload running did not finish. Null for every other state. format: date-time nullable: true type: string uploadStatus: $ref: '#/components/schemas/ArtifactUploadStatusEnum' uploadedBy: $ref: '#/components/schemas/UserInfo' required: - id - createdAt - createdBy - updatedAt - updatedBy - fileName - fileType - fileSize - uploadStatus - schemaInferenceStatus - uploadedBy - kind - madeByPonder type: object ResponseLinks: properties: first: nullable: true type: string last: nullable: true type: string next: nullable: true type: string prev: nullable: true type: string type: object ResponseMeta: properties: requestId: description: Unique identifier for the request type: string totalCount: description: Total count of items for paginated responses nullable: true type: integer required: - requestId type: object ProblemDetails: description: An error response in the Problem Details format (RFC 9457). properties: code: description: The stable error code, when the problem has one. example: WA-VL-001 type: string detail: description: What went wrong with this request. type: string details: description: >- Structured facts about the refusal, such as the entity or the path it concerns. Only some refusals have it. errors: description: >- The fields or filters that failed validation. Only a validation or filter error has it. requestId: description: >- The ID of the request, when the problem has one. The `X-Request-ID` response header always has it. type: string status: description: The HTTP status code. example: 400 type: integer title: description: A short summary, usually the text of the HTTP status. example: Bad Request type: string type: description: >- The problem type. It is `about:blank`: the status and `code` identify the problem. example: about:blank type: string required: - type - title - status - detail type: object ArtifactWorkStatus: properties: artifactId: description: UUID v4 with automatic base62 encoding for client-facing APIs pattern: >- ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ type: string errorCode: oneOf: - $ref: '#/components/schemas/ArtifactWorkErrorCode' - enum: - null nullable: true type: string errorMessage: nullable: true type: string state: $ref: '#/components/schemas/ArtifactWorkState' tapId: description: UUID v4 with automatic base62 encoding for client-facing APIs nullable: true pattern: >- ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ type: string workId: description: UUID v4 with automatic base62 encoding for client-facing APIs pattern: >- ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ type: string required: - workId - artifactId - state type: object ArtifactTypeEnum: description: >- Type of uploaded artifact file. The allowlist in connectors-shared-types (ArtifactFileTypeTable) says which extensions name each type, which scopes accept it and how it is served. enum: - csv - xlsx - xls - numbers - ods - zip - png - jpeg - gif - webp - avif - heic - heif - jxl - svg - mp4 - m4v - mov - webm - ttf - otf - woff - woff2 - fig - jam - parquet - jsonl - jsonl_gz type: string ArtifactKindEnum: description: 'What a file is for a person: the group it shows in and how it previews.' enum: - image - video - font - design - data - spreadsheet - archive type: string ArtifactMedia: additionalProperties: false description: >- What the worker read from a file. One member is set, for the file's kind. properties: design: oneOf: - $ref: '#/components/schemas/ArtifactDesignMedia' - enum: - null nullable: true type: object font: oneOf: - $ref: '#/components/schemas/ArtifactFontMedia' - enum: - null nullable: true type: object image: oneOf: - $ref: '#/components/schemas/ArtifactImageMedia' - enum: - null nullable: true type: object video: oneOf: - $ref: '#/components/schemas/ArtifactVideoMedia' - enum: - null nullable: true type: object type: object ArtifactSchemaInferenceStatusEnum: description: Status of optional schema inference for an artifact enum: - not_requested - processing - succeeded - failed - skipped_by_policy type: string ArtifactUploadStatusEnum: description: Availability status of an uploaded artifact file enum: - pending - processing - ready - failed type: string UserInfo: description: |- A type for general info about a user for returning enough public facing user info for fields like createdBy or updatedBy. properties: email: description: An email address format: email maxLength: 255 pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ type: string id: description: UUID v4 with automatic base62 encoding for client-facing APIs pattern: >- ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ type: string name: description: An objects name maxLength: 80 minLength: 2 type: string required: - id - name - email type: object ArtifactWorkErrorCode: enum: - INVALID_SOURCE - INVALID_SCHEMA - SIZE_MISMATCH - CHECKSUM_MISMATCH - ROW_COUNT_MISMATCH - UNSUPPORTED_FORMAT - STORAGE_ERROR - CANCELLED - INTERNAL_ERROR - DISPATCH_REJECTED - DISPATCH_EXHAUSTED type: string ArtifactWorkState: enum: - PENDING - CLAIMED - RUNNING - SUCCEEDED - FAILED - CANCELLED type: string ArtifactDesignMedia: additionalProperties: false properties: hasThumbnail: description: The file holds a thumbnail picture of its first page. type: boolean required: - hasThumbnail type: object ArtifactFontMedia: additionalProperties: false description: |- What a font file says about itself. `family` is the CSS name: the typographic family (name ID 16), else the family (name ID 1). It never changes, so CSS that names it keeps working. properties: axes: items: $ref: '#/components/schemas/ArtifactFontAxis' type: array family: type: string fullName: nullable: true type: string instances: items: $ref: '#/components/schemas/ArtifactFontInstance' type: array italic: type: boolean postscriptName: nullable: true type: string revision: description: head.fontRevision. The higher revision of one style wins. format: double type: number sampleText: description: The font's own sample text (name ID 19). nullable: true type: string subfamily: description: 'The style label: typographic subfamily (name ID 17), else ID 2.' type: string weight: description: OS/2 usWeightClass, 1 to 1000. format: int64 maximum: 9007199254740991 minimum: -9007199254740991 type: integer width: description: OS/2 usWidthClass, 1 (ultra-condensed) to 9 (ultra-expanded). format: int64 maximum: 9007199254740991 minimum: -9007199254740991 type: integer required: - family - subfamily - weight - width - italic - revision - axes - instances type: object ArtifactImageMedia: additionalProperties: false properties: animated: type: boolean height: description: >- Signed 64-bit integer; range bounded by JavaScript's safe-integer ceiling. format: int64 maximum: 9007199254740991 minimum: -9007199254740991 nullable: true type: integer width: description: >- Signed 64-bit integer; range bounded by JavaScript's safe-integer ceiling. format: int64 maximum: 9007199254740991 minimum: -9007199254740991 nullable: true type: integer required: - animated type: object ArtifactVideoMedia: additionalProperties: false properties: codec: description: The video codec the container names, such as "avc1" or "hvc1". nullable: true type: string durationMs: description: >- Signed 64-bit integer; range bounded by JavaScript's safe-integer ceiling. format: int64 maximum: 9007199254740991 minimum: -9007199254740991 nullable: true type: integer height: description: >- Signed 64-bit integer; range bounded by JavaScript's safe-integer ceiling. format: int64 maximum: 9007199254740991 minimum: -9007199254740991 nullable: true type: integer width: description: >- Signed 64-bit integer; range bounded by JavaScript's safe-integer ceiling. format: int64 maximum: 9007199254740991 minimum: -9007199254740991 nullable: true type: integer type: object ArtifactFontAxis: additionalProperties: false description: One variation axis of a variable font, such as wght 100–900. properties: default: description: A finite 64-bit floating-point number format: double type: number max: description: A finite 64-bit floating-point number format: double type: number min: description: A finite 64-bit floating-point number format: double type: number tag: type: string required: - tag - min - default - max type: object ArtifactFontInstance: additionalProperties: false description: A named style of a variable font, such as "Bold" at wght 700. properties: coordinates: items: $ref: '#/components/schemas/ArtifactFontAxisValue' type: array name: type: string required: - name - coordinates type: object ArtifactFontAxisValue: additionalProperties: false properties: tag: type: string value: description: A finite 64-bit floating-point number format: double type: number required: - tag - value type: object headers: X-Request-ID: description: >- The ID of the request. It is the `X-Request-ID` value that you sent, or an ID that the server made. Give it when you report a problem. schema: type: string securitySchemes: bearerAuth: description: >- A personal access token, which starts with `pat_`. A Parable token can call each operation that the roles of its owner allow. An MCP token can call only the read operations that are open to agents. A SQL token does not work on this API. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.