Skip to content

Update Directory File

client.Beta.Directories.Files.Update(ctx, directoryFileID, params) (*BetaDirectoryFileUpdateResponse, error)
PATCH/api/v1/beta/directories/{directory_id}/files/{directory_file_id}

Update directory-file metadata by directory_file_id; set directory_id to move the file to a different directory. To resolve from unique_id, list with a filter first.

ParametersExpand Collapse
directoryFileID string
params BetaDirectoryFileUpdateParams
DirectoryID param.Field[string]

Path param

OrganizationID param.Field[string]optional

Query param

formatuuid
ProjectID param.Field[string]optional

Query param

formatuuid
DisplayName param.Field[string]optional

Body param: Updated display name.

Metadata param.Field[map[string, BetaDirectoryFileUpdateParamsMetadataUnion]]optional

Body param: User-defined metadata key-value pairs. Replaces the user metadata layer.

string
int64
float64
bool
type BetaDirectoryFileUpdateParamsMetadataMetadataListValue []string
TargetDirectoryID param.Field[string]optional

Body param: Move file to a different directory.

UniqueID param.Field[string]optional

Body param: Updated unique identifier.

minLength1
ReturnsExpand Collapse
type BetaDirectoryFileUpdateResponse struct{…}

API response schema for a directory file.

ID string

Unique identifier for the directory file.

DirectoryID string

Directory the file belongs to.

DisplayName string

Display name for the file.

minLength1
ProjectID string

Project the directory file belongs to.

UniqueID string

Unique identifier for the file in the directory

minLength1
CreatedAt Timeoptional

Creation datetime

formatdate-time
DeletedAt Timeoptional

Soft delete marker when the file is removed upstream or by user action.

formatdate-time
DownloadURL PresignedURLoptional

Schema for a presigned URL.

ExpiresAt Time

The time at which the presigned URL expires

formatdate-time
URL string

A presigned URL for IO operations against a private file

minLength1
formaturi
FormFields map[string, string]optional

Form fields for a presigned POST request

FileID stringoptional

File ID for the storage location.

Metadata map[string, BetaDirectoryFileUpdateResponseMetadataUnion]optional

Merged metadata from all sources. Higher-priority sources override lower.

One of the following:
string
int64
float64
bool
type BetaDirectoryFileUpdateResponseMetadataMetadataListValue []string
UpdatedAt Timeoptional

Update datetime

formatdate-time

Update Directory File

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/llamacloud-prod-go"
  "github.com/stainless-sdks/llamacloud-prod-go/option"
)

func main() {
  client := llamacloudprod.NewClient(
    option.WithAPIKey("My API Key"),
  )
  file, err := client.Beta.Directories.Files.Update(
    context.TODO(),
    "directory_file_id",
    llamacloudprod.BetaDirectoryFileUpdateParams{
      DirectoryID: "directory_id",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", file.ID)
}
{
  "id": "id",
  "directory_id": "directory_id",
  "display_name": "x",
  "project_id": "project_id",
  "unique_id": "x",
  "created_at": "2019-12-27T18:11:19.117Z",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "download_url": {
    "expires_at": "2019-12-27T18:11:19.117Z",
    "url": "https://example.com",
    "form_fields": {
      "foo": "string"
    }
  },
  "file_id": "file_id",
  "metadata": {
    "foo": "string"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
Returns Examples
{
  "id": "id",
  "directory_id": "directory_id",
  "display_name": "x",
  "project_id": "project_id",
  "unique_id": "x",
  "created_at": "2019-12-27T18:11:19.117Z",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "download_url": {
    "expires_at": "2019-12-27T18:11:19.117Z",
    "url": "https://example.com",
    "form_fields": {
      "foo": "string"
    }
  },
  "file_id": "file_id",
  "metadata": {
    "foo": "string"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}