File programs: create, get, list

Reference for File, one group of File programs.

File.create

Creates a File. Verb page.

Text

do: return await $.File.create(input)

Emits File.created.

Inputs

Input	Type	Required	Description
`contentType`	`string`	required	The media type, such as `application/pdf`.
`size`	`integer`	required	The size in bytes.
`name`	`string`		The file name it was uploaded with.
`visibility`	`string`		Who may read it: `Owner`, `Customer`, or `Public`. The default is `Owner`.
`document`	Document		Each rendering of a Document to a format, such as PDF, is stored as a File.

Returns

Output	Type	Required	Description
`file`	File	required	The File.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.File.create({ contentType: 'Example content type', size: 1 })"
  }
}

Returns one File by id. Verb page.

Text

do: return await $.File.get(input)

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the File.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`file`	File	required	The File.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.File.get({ id: 'file_V1AuhyCTsH' })"
  }
}

Returns Files, newest first, one page at a time. Verb page.

Text

do: return await $.File.list(input)

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`files`	list of File	required	One page of Files.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.File.list({ limit: 20 })"
  }
}