{
"opencollection": "1.0.0",
"info": {
"name": "API Reference Accounts Files API",
"version": "0.0.0"
},
"items": [
{
"info": {
"name": "Files",
"type": "folder"
},
"items": [
{
"info": {
"name": "List files",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/files",
"headers": [
{
"name": "Lightfield-Version",
"value": "2026-03-01"
}
],
"params": [
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a paginated list of files in your workspace. Use `offset` and `limit` to paginate through results. See [List endpoints](/using-the-api/list-endpoints/) for more information about pagination.\n\n**[Required scope](/using-the-api/scopes/):** `files:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Search"
},
{
"info": {
"name": "Create a file upload session",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/files",
"headers": [
{
"name": "Lightfield-Version",
"value": "2026-03-01"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a new file upload session and returns an upload URL.\n\nAfter uploading the file bytes to `uploadUrl`, call `POST /v1/files/{id}/complete` to finalize the upload. Optionally pass `purpose` to validate MIME type and size constraints at creation time. See [File uploads](/using-the-api/file-uploads/) for the full upload flow, supported purposes, and size limits. If you are uploading a meeting transcript, see [Uploading meeting transcripts](/using-the-api/uploading-meeting-transcript"
},
{
"info": {
"name": "Complete a file upload",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/files/:id/complete",
"headers": [
{
"name": "Lightfield-Version",
"value": "2026-03-01"
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Finalizes an upload after the file bytes have been uploaded.\n\nIf an optional `md5` hex digest is provided, the server validates the checksum before marking the file as completed.\n\n**[Required scope](/using-the-api/scopes/):** `files:create`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Write"
},
{
"info": {
"name": "Retrieve a file",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/files/:id",
"headers": [
{
"name": "Lightfield-Version",
"value": "2026-03-01"
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a single file by its ID.\n\n**[Required scope](/using-the-api/scopes/):** `files:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Read"
},
{
"info": {
"name": "Get a file download URL",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/files/:id/url",
"headers": [
{
"name": "Lightfield-Version",
"value": "2026-03-01"
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Returns a temporary download URL for the file. Only available for files in `COMPLETED` status.\n\n**[Required scope](/using-the-api/scopes/):** `files:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Read"
},
{
"info": {
"name": "Cancel a file upload",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/files/:id/cancel",
"headers": [
{
"name": "Lightfield-Version",
"value": "2026-03-01"
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Cancels a pending upload by transitioning the file to `CANCELLED`. Only files in `PENDING` status can be cancelled. **[Required scope](/using-the-api/scopes/):** `files:create`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Write"
}
]
}
],
"bundled": true
}