API reference

Upload File

POST /v1/files

POST/v1/files

Upload up to 10 MB; files are organization-private and expire after 30 days.

Authentication

Send your organization’s secret key as Authorization: Bearer $FOUS_API_KEY. See authentication.

Parameters

Name	Location	Required	Type	Description
`X-File-Name`	header	Yes	string	URI-encoded filename, up to 160 decoded characters.

Request body

A request body is required.

application/octet-stream

Full schema:

{
  "type": "string",
  "format": "binary"
}

Responses

201

Success

application/json

Field	Type	Required	Description
`success`	value	Yes
`data`	File	Yes

Full schema:

{
  "type": "object",
  "properties": {
    "success": {
      "const": true
    },
    "data": {
      "$ref": "#/components/schemas/File"
    }
  },
  "required": [
    "success",
    "data"
  ],
  "additionalProperties": false
}

400

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

401

Standard error. Inspect error.code, details and request_id.

WWW-Authenticate: Bearer authentication challenge; invalid or expired keys use invalid_token.

application/json

See the Error schema and error handling guide.

402

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

403

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

404

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

408

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

409

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

413

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

422

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

429

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

500

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

502

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

503

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

504

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.