> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getruba.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create File
> ### Intent
Creates a file from the values supplied in the request.
### When to call it
Call this when your application has collected the required values and is ready to create a file.
### Access boundary
Authorize the request with a token that carries `files:write`.
### Successful result
A successful request returns `201`. The response schema below defines the body your integration receives.
export const RubaSocials = () => {
if (typeof document === "undefined") {
return null;
}
const inject = () => {
const footer = document.getElementById("footer");
if (!footer || document.getElementById("ruba-socials")) {
return false;
}
const isDark = document.querySelector("html.dark") || document.querySelector('html[class*="dark"]');
const lineColor = isDark ? "#383838" : "#e8e8ed";
const iconColor = isDark ? "#8e8e93" : "#86868b";
const markColor = isDark ? "#ffffff" : "#08080c";
const hoverColor = "#0071e3";
const div = document.createElement("div");
div.id = "ruba-socials";
div.style.cssText = `display:flex;align-items:center;gap:20px;padding-top:20px;margin-top:20px;border-top:1px solid ${lineColor};width:100%`;
const logo = `Ruba`;
const spacer = ``;
const ig = ``;
const li = ``;
const x = ``;
const github = ``;
div.innerHTML = logo + spacer + ig + li + x + github;
footer.appendChild(div);
return true;
};
if (!document.documentElement.dataset.rubaSocialsObserver) {
document.documentElement.dataset.rubaSocialsObserver = "true";
const observer = new MutationObserver(() => {
if (!document.getElementById("ruba-socials")) {
inject();
}
});
observer.observe(document.body, {
childList: true,
subtree: true
});
}
setTimeout(() => {
if (!inject()) {
const interval = setInterval(() => {
if (inject()) {
clearInterval(interval);
}
}, 500);
setTimeout(() => clearInterval(interval), 10000);
}
}, 300);
return null;
};
## OpenAPI
````yaml post /v1/files/
openapi: 3.1.0
info:
title: Ruba API
summary: Ruba HTTP and Webhooks API
description: '**Details:** Read the docs at https://docs.getruba.com/api-reference.'
version: 2026-04
servers:
- url: https://api.getruba.com
description: '**Details:** Production environment.'
x-speakeasy-server-id: production
- url: https://sandbox-api.getruba.com
description: '**Details:** Sandbox environment.'
x-speakeasy-server-id: sandbox
security: []
tags:
- name: public
description: >-
**Details:** Endpoints shown and documented in the Ruba API documentation
and available in our SDKs.
- name: private
description: >-
**Details:** Endpoints that should appear in the schema only in
development to generate our internal JS SDK.
paths:
/v1/files/:
post:
tags:
- files
- public
summary: Create File
description: >-
### Intent
Creates a file from the values supplied in the request.
### When to call it
Call this when your application has collected the required values and is
ready to create a file.
### Access boundary
Authorize the request with a token that carries `files:write`.
### Successful result
A successful request returns `201`. The response schema below defines
the body your integration receives.
operationId: files:create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FileCreate'
responses:
'201':
description: '**Response:** File created.'
content:
application/json:
schema:
$ref: '#/components/schemas/FileUpload'
'422':
description: Request validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- oidc:
- files:write
- pat:
- files:write
- oat:
- files:write
components:
schemas:
FileCreate:
oneOf:
- $ref: '#/components/schemas/DownloadableFileCreate'
- $ref: '#/components/schemas/ProductMediaFileCreate'
- $ref: '#/components/schemas/OrganizationAvatarFileCreate'
- $ref: '#/components/schemas/SupportCaseAttachmentFileCreate'
discriminator:
propertyName: service
mapping:
downloadable:
$ref: '#/components/schemas/DownloadableFileCreate'
organization_avatar:
$ref: '#/components/schemas/OrganizationAvatarFileCreate'
product_media:
$ref: '#/components/schemas/ProductMediaFileCreate'
support_case_attachment:
$ref: '#/components/schemas/SupportCaseAttachmentFileCreate'
FileUpload:
properties:
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
organization_id:
type: string
format: uuid4
title: Organization Id
name:
type: string
title: Name
path:
type: string
title: Path
mime_type:
type: string
title: Mime Type
size:
type: integer
title: Size
storage_version:
anyOf:
- type: string
- type: 'null'
title: Storage Version
checksum_etag:
anyOf:
- type: string
- type: 'null'
title: Checksum Etag
checksum_sha256_base64:
anyOf:
- type: string
- type: 'null'
title: Checksum Sha256 Base64
checksum_sha256_hex:
anyOf:
- type: string
- type: 'null'
title: Checksum Sha256 Hex
last_modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Modified At
upload:
$ref: '#/components/schemas/S3FileUploadMultipart'
version:
anyOf:
- type: string
- type: 'null'
title: Version
is_uploaded:
type: boolean
title: Is Uploaded
default: false
service:
$ref: '#/components/schemas/FileServiceTypes'
size_readable:
type: string
title: Size Readable
readOnly: true
type: object
required:
- id
- organization_id
- name
- path
- mime_type
- size
- storage_version
- checksum_etag
- checksum_sha256_base64
- checksum_sha256_hex
- last_modified_at
- upload
- version
- service
- size_readable
title: FileUpload
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
DownloadableFileCreate:
properties:
organization_id:
anyOf:
- type: string
format: uuid4
description: Identifier of the organization.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
- type: 'null'
title: Organization Id
name:
type: string
title: Name
mime_type:
type: string
title: Mime Type
size:
type: integer
title: Size
checksum_sha256_base64:
anyOf:
- type: string
- type: 'null'
title: Checksum Sha256 Base64
upload:
$ref: '#/components/schemas/S3FileCreateMultipart'
service:
type: string
const: downloadable
title: Service
version:
anyOf:
- type: string
- type: 'null'
title: Version
type: object
required:
- name
- mime_type
- size
- upload
- service
title: DownloadableFileCreate
description: >-
Schema used to create a file to be associated with the downloadables
benefit.
ProductMediaFileCreate:
properties:
organization_id:
anyOf:
- type: string
format: uuid4
description: Identifier of the organization.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
- type: 'null'
title: Organization Id
name:
type: string
title: Name
mime_type:
type: string
pattern: ^image\/(jpeg|png|gif|webp|svg\+xml)$
title: Mime Type
description: >-
**Mime Type:** MIME type of the file. Only images are supported for
this type of file.
size:
type: integer
maximum: 10485760
title: Size
description: >-
**Size:** Size of the file. A maximum of 10 MB is allowed for this
type of file.
checksum_sha256_base64:
anyOf:
- type: string
- type: 'null'
title: Checksum Sha256 Base64
upload:
$ref: '#/components/schemas/S3FileCreateMultipart'
service:
type: string
const: product_media
title: Service
version:
anyOf:
- type: string
- type: 'null'
title: Version
type: object
required:
- name
- mime_type
- size
- upload
- service
title: ProductMediaFileCreate
description: Schema used to create a file to be used as a product media file.
OrganizationAvatarFileCreate:
properties:
organization_id:
anyOf:
- type: string
format: uuid4
description: Identifier of the organization.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
- type: 'null'
title: Organization Id
name:
type: string
title: Name
mime_type:
type: string
pattern: ^image\/(jpeg|png|gif|webp|svg\+xml)$
title: Mime Type
description: >-
**Mime Type:** MIME type of the file. Only images are supported for
this type of file.
size:
type: integer
maximum: 1048576
title: Size
description: >-
**Size:** Size of the file. A maximum of 1 MB is allowed for this
type of file.
checksum_sha256_base64:
anyOf:
- type: string
- type: 'null'
title: Checksum Sha256 Base64
upload:
$ref: '#/components/schemas/S3FileCreateMultipart'
service:
type: string
const: organization_avatar
title: Service
version:
anyOf:
- type: string
- type: 'null'
title: Version
type: object
required:
- name
- mime_type
- size
- upload
- service
title: OrganizationAvatarFileCreate
description: Schema used to create a file to be used as an organization avatar.
SupportCaseAttachmentFileCreate:
properties:
organization_id:
anyOf:
- type: string
format: uuid4
description: Identifier of the organization.
examples:
- 1dbfc517-0bbf-4301-9ba8-555ca42b9737
x-ruba-selector-widget:
displayProperty: name
resourceName: Organization
resourceRoot: /v1/organizations
- type: 'null'
title: Organization Id
name:
type: string
title: Name
mime_type:
type: string
pattern: >-
^(image\/(jpeg|png|gif|webp)|video\/(mp4|quicktime|webm)|application\/pdf|text\/(csv|plain)|application\/msword|application\/vnd\.openxmlformats-officedocument\.wordprocessingml\.document|application\/vnd\.ms-excel|application\/vnd\.openxmlformats-officedocument\.spreadsheetml\.sheet)$
title: Mime Type
description: >-
**Mime Type:** MIME type of the file. Images, videos, PDF, CSV,
plain text, Word and Excel documents are supported.
size:
type: integer
maximum: 262144000
title: Size
description: >-
**Size:** Size of the file. A maximum of 250 MB is allowed for this
type of file.
checksum_sha256_base64:
anyOf:
- type: string
- type: 'null'
title: Checksum Sha256 Base64
upload:
$ref: '#/components/schemas/S3FileCreateMultipart'
service:
type: string
const: support_case_attachment
title: Service
version:
anyOf:
- type: string
- type: 'null'
title: Version
type: object
required:
- name
- mime_type
- size
- upload
- service
title: SupportCaseAttachmentFileCreate
description: Schema used to create a file attached to a support case.
S3FileUploadMultipart:
properties:
id:
type: string
title: Id
path:
type: string
title: Path
parts:
items:
$ref: '#/components/schemas/S3FileUploadPart'
type: array
title: Parts
type: object
required:
- id
- path
- parts
title: S3FileUploadMultipart
FileServiceTypes:
type: string
enum:
- downloadable
- product_media
- organization_avatar
- support_case_attachment
title: FileServiceTypes
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
S3FileCreateMultipart:
properties:
parts:
items:
$ref: '#/components/schemas/S3FileCreatePart'
type: array
title: Parts
type: object
required:
- parts
title: S3FileCreateMultipart
S3FileUploadPart:
properties:
number:
type: integer
title: Number
chunk_start:
type: integer
title: Chunk Start
chunk_end:
type: integer
title: Chunk End
checksum_sha256_base64:
anyOf:
- type: string
- type: 'null'
title: Checksum Sha256 Base64
url:
type: string
title: Url
expires_at:
type: string
format: date-time
title: Expires At
headers:
additionalProperties:
type: string
type: object
title: Headers
default: {}
type: object
required:
- number
- chunk_start
- chunk_end
- url
- expires_at
title: S3FileUploadPart
S3FileCreatePart:
properties:
number:
type: integer
title: Number
chunk_start:
type: integer
title: Chunk Start
chunk_end:
type: integer
title: Chunk End
checksum_sha256_base64:
anyOf:
- type: string
- type: 'null'
title: Checksum Sha256 Base64
type: object
required:
- number
- chunk_start
- chunk_end
title: S3FileCreatePart
securitySchemes:
oidc:
type: openIdConnect
openIdConnectUrl: /.well-known/openid-configuration
pat:
type: http
description: >-
**Authentication:** You can generate a **Personal Access Token** from
your [settings](https://getruba.com/settings).
scheme: bearer
oat:
type: http
description: >-
**Authentication:** You can generate an **Organization Access Token**
from your organization's settings.
scheme: bearer
````