GET
/
v4
/
beta
/
files
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const file of client.beta.files.list()) {
    console.log(file.id);
  }
}

main();
{
  "object": "list",
  "items": [
    {
      "size": 123,
      "md5_checksum": "<string>",
      "filename": "<string>",
      "mime_type": "<string>",
      "tags": {},
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by_user_id": "<string>",
      "object": "file"
    }
  ],
  "limit": 100,
  "total": 123,
  "has_more": true
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
starting_after
string | null
​
ending_before
string | null
​
limit
integer
default:
100
Required range: 1 < x < 1000

Response

200
application/json
Successful Response
​
items
object[]
required
​
total
integer
required

The total of items that match the query. This is greater than or equal to the number of items returned.

​
has_more
boolean
required

Whether there are more items left to be fetched.

​
object
enum<string>
default:
list
Available options:
list
​
limit
integer
default:
100

The maximum number of items to return.

CompletionsUpload File