Upstage Document Chat icon

Upstage Document Chat

Chat with documents using Upstage Solar models

Retrieve File

AI-generated

Summary

Retrieves metadata and content details for a specific file ID from the Upstage Solar API.

Inputs

  • fileId (required) — The ID of the file to retrieve.
  • retrieveOptions — Optional settings to filter the retrieved data.

Output shape

A JSON object containing file metadata and content.

The output shape depends on the 'View' option in retrieveOptions. 'All' returns full details including elements; 'Summary' returns summary information only.

Examples

Example 1: Retrieve full file details by ID

File ID: 'abc-123'; View: 'All'

Example 2: Retrieve summary information for specific pages

File ID: 'abc-123'; Pages: '1-5'; View: 'Summary'

Discussion