Files

Get file status

Retrieve the current status and metadata of an uploaded file. Use this to poll for extraction completion after uploading a file.

get/files/{id}

Request

Base URL
https://app.gc.ai/api/external/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/files/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

The file ID

File metadata and status

idstring uuid required

Unique file identifier

namestring required

Original filename

sizenumber required

File size in bytes

content_typestring required

MIME type of the file

status'extracting' | 'embedding' | 'ready' | 'failed' required

Current processing status of the file

created_atstring required

ISO 8601 creation timestamp

folder_idstring uuid nullable

Folder the file belongs to

extraction_errorstring

Error message if extraction failed

project_idstring uuid

Project the file is linked to, if uploaded with project_id

warningstring

Present when the file was uploaded successfully but a secondary operation (e.g. project linking) failed

{
  "content_type": "application/pdf"
}

No recorded changes to this operation across all 1 revision of this API.