Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarFile

File routes: create, get, list

The File Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for File, one group of File routes.

File.create

Creates a File. Verb page.

Text
POST /{namespace}/files

Body, as JSON: the inputs. Emits File.created.

Inputs

InputTypeRequiredDescription
contentTypestringrequiredThe media type, such as application/pdf.
sizeintegerrequiredThe size in bytes.
namestringThe file name it was uploaded with.
visibilitystringWho may read it: Owner, Customer, or Public. The default is Owner.
documentDocumentEach rendering of a Document to a format, such as PDF, is stored as a File.

Returns

OutputTypeRequiredDescription
fileFilerequiredThe File.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/files \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contentType":"Example content type","size":1}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "file": {
    "$id": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH",
    "$type": "File",
    "contentType": "Example content type",
    "size": 1
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "File.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

File.get

Returns one File by id. Verb page.

Text
GET /{namespace}/files/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the File.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
fileFilerequiredThe File.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/files/file_V1AuhyCTsH \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "File",
  "$id": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH",
  "file": {
    "$id": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH",
    "$type": "File",
    "contentType": "Example content type",
    "size": 1
  },
  "links": {
    "self": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH",
    "up": "https://api.sb/leaseline.app/files"
  },
  "actions": {
    "edit": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH/edit"
  }
}

File.list

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

Text
GET /{namespace}/files

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
fileslist of FilerequiredOne page of Files.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/files?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "File",
  "files": [
    {
      "$id": "https://api.sb/leaseline.app/files/file_V1AuhyCTsH",
      "$type": "File",
      "contentType": "Example content type",
      "size": 1
    }
  ],
  "meta": {
    "limit": 20,
    "after": "file_V1AuhyCTsH"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/files?limit=20",
    "next": "https://api.sb/leaseline.app/files?after=file_V1AuhyCTsH"
  }
}

File

Previous

update, delete

Next