Create a file | Collate API Documentation

Creates a file resource and returns the upload target for the bytes.

Upload the raw bytes to upload.url using the returned method and headers, then call Complete a file to mark the file ready. Until the file is ready, you cannot attach it to an authorization.

File creation does not link the file to anything. Attach a ready file to an authorization with Attach a file.

Returns

Returns the pending file and a single-use upload target.

Creates a file resource and returns the upload target for the bytes. Upload the raw bytes to `upload.url` using the returned method and headers, then call [Complete a file](api:POST/v1/files/{file_id}/complete) to mark the file ready. Until the file is `ready`, you cannot attach it to an authorization. File creation does not link the file to anything. Attach a `ready` file to an authorization with [Attach a file](api:POST/v1/prior-authorizations/{authorization_id}/attachments). ## Returns Returns the pending file and a single-use upload target.

Authentication

AuthorizationBearer

API key passed as Authorization: Bearer <API_KEY>.

Request

This endpoint expects an object.

fileNamestringRequired

Name of the file you plan to upload.

contentTypeenumRequired

MIME type of the file bytes.

Allowed values:

purposeenumRequired

Use authorization_attachment for prior-auth supporting documents.

Allowed values:

Response

Successful Response

fileobject

Created file resource.

uploadobject

Upload target for the file bytes.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error

$	curl -X POST https://api.sandbox.trycollate.ai/v1/files \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"fileName": "string",
>	"contentType": "application/pdf",
>	"purpose": "authorization_attachment"
>	}'

1	{
2	"file": {
3	"id": "string",
4	"status": "pending_upload",
5	"fileName": "string",
6	"contentType": "application/pdf",
7	"purpose": "authorization_attachment",
8	"createdAt": "2024-01-15T09:30:00Z",
9	"sizeBytes": 1,
10	"completedAt": "2024-01-15T09:30:00Z",
11	"downloadUrl": "string"
12	},
13	"upload": {
14	"url": "string",
15	"strategy": "single_put",
16	"method": "PUT",
17	"headers": {}
18	}
19	}