Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
mutation CreateFile($input: FileCreateJsonInput!) {
createFile(input: $input) {
id
object
livemode
created
updated
purpose
filename
content_type
size
sha256
url
url_expires_at
expires_at
}
}
{
"input": {
"purpose": "customs_document",
"filename": "example",
"content_type": "example",
"data": "example"
}
}
{
"data": {
"createFile": {
"id": "file_1a2B3c",
"object": "file",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"purpose": "customs_document",
"filename": "example",
"content_type": "example",
"size": 2,
"sha256": "example",
"url": "https://example.com/resource",
"url_expires_at": 1791302400,
"expires_at": 1791302400
}
}
}
Upload a file
mutation CreateFile($input: FileCreateJsonInput!) {
createFile(input: $input) {
id
object
livemode
created
updated
purpose
filename
content_type
size
sha256
url
url_expires_at
expires_at
}
}
{
"input": {
"purpose": "customs_document",
"filename": "example",
"content_type": "example",
"data": "example"
}
}
{
"data": {
"createFile": {
"id": "file_1a2B3c",
"object": "file",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"purpose": "customs_document",
"filename": "example",
"content_type": "example",
"size": 2,
"sha256": "example",
"url": "https://example.com/resource",
"url_expires_at": 1791302400,
"expires_at": 1791302400
}
}
}
mutation · Module: Files · Requires documents:write
| Argument | Type | Description |
|---|---|---|
input | FileCreateJsonInput | The fields for this operation. |
FileCreateJsonInput fields| Field | Type |
|---|---|
purpose | FileCreateJsonInputPurpose |
filename | String |
content_type | String |
data | String |
user_metadata | UserMetadataInput |
File!
| Field | Type |
|---|---|
id | String! |
object | FileObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
purpose | FilePurpose! |
filename | String |
content_type | String |
size | Int! |
sha256 | String |
url | String |
url_expires_at | Int |
expires_at | Int |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
mutation CreateFile($input: FileCreateJsonInput!) {
createFile(input: $input) {
id
object
livemode
created
updated
purpose
filename
content_type
size
sha256
url
url_expires_at
expires_at
}
}
{
"input": {
"purpose": "customs_document",
"filename": "example",
"content_type": "example",
"data": "example"
}
}
{
"data": {
"createFile": {
"id": "file_1a2B3c",
"object": "file",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"purpose": "customs_document",
"filename": "example",
"content_type": "example",
"size": 2,
"sha256": "example",
"url": "https://example.com/resource",
"url_expires_at": 1791302400,
"expires_at": 1791302400
}
}
}