Skip to contents

Gets the status and metadata of a file uploaded to an assistant.

Usage

assistant_describe_file(assistant_name, file_id, include_url = FALSE)

Arguments

assistant_name

Name of the assistant

file_id

UUID of the file to describe

include_url

Whether to include a signed URL for the file (default: FALSE)

Value

List with http response, content (file details), and status_code. Content includes: - id: File UUID - name: File name - status: File status ("Processing", "Available", "Failed") - size: File size in bytes - metadata: File metadata - created_on: Creation timestamp - updated_on: Last update timestamp - percent_done: Processing progress - signed_url: Signed URL for download (if include_url = TRUE) - error_message: Error message (if status is "Failed")

Examples

if (FALSE) { # \dontrun{
# Get file status
assistant_describe_file("my-assistant", "070513b3-022f-4966-b583-a9b12e0290ff")

# Get file with signed download URL
assistant_describe_file(
  "my-assistant",
  "070513b3-022f-4966-b583-a9b12e0290ff",
  include_url = TRUE
)
} # }