Retrieve a document

Retrieve a single document by its ID. Only documents that the requesting user is authorized to access will be returned.

GET /api/v2/files/{id}

Try it

Retrieve a document

cURL

curl --request GET \
  --url https://paradigm.lighton.ai/api/v2/files/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": 123,
  "object": "<string>",
  "created_at": 123,
  "filename": "<string>",
  "purpose": "<string>",
  "status": "<string>",
  "content": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer token authentication

Path Parameters

id · integer · required

The ID of the document to retrieve.

Query Parameters

include_content · boolean

Include the content of the document in the response.

Response

200

application/json

File

Response serializer for file retrieve results.

id · integer · required

Unique identifier for the file

object · string · required

Object type, always 'file'

created_at · integer · required

Unix timestamp of when the file was created

filename · string · required

Original filename of the file

purpose · string · required

Purpose of the file, always 'documents'

status · string · required

Processing status of the file

content · string

Content of the file (included only when include_content=true)