How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Smokeball Files API

The Files API from Smokeball — 8 operation(s) for files.

Smokeball Files API is one of 34 APIs that Smokeball publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include File. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a GitHub repository, and 1 JSON Schema.

This API exposes 13 operations across 8 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 6 base URLs: https://api.smokeball.com, https://api.smokeball.com.au, https://api.smokeball.co.uk, https://stagingapi.smokeball.com, https://stagingapi.smokeball.com.au, https://stagingapi.smokeball.co.uk.

13 operations 8 paths 11 schemas 1 DELETE7 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.smokeball.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Smokeball Files API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api-key). An API key is passed in the header as Authorization (token). By default, every request must be authenticated.

Paths & Operations 13

Across 8 paths, the API surfaces 13 operations — 1 DELETE, 7 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Files 13
GET
/matters/{matterId}/documents/files
Get files on a matter
GetFiles 6 params → 200403
POST
/matters/{matterId}/documents/files
Add file to a matter
AddFile 1 param body → 202400
GET
/matters/{matterId}/documents/files/{fileId}
Get a file
GetFileById 2 params → 200403404
PUT
/matters/{matterId}/documents/files/{fileId}
Upload/update version or metadata of a file
UpdateFile 2 params body → 202400404
PATCH
/matters/{matterId}/documents/files/{fileId}
Patch a file
PatchFile 2 params body → 202400404
DELETE
/matters/{matterId}/documents/files/{fileId}
Delete a file
DeleteFile 2 params → 202400403
GET
/matters/{matterId}/documents/files/{fileId}/download
Get download url for a file
DownloadFile 3 params → 200400403404
GET
/matters/{matterId}/documents/files/{fileId}/upload
Get upload url for a file
UploadFile 2 params → 200403404
GET
/matters/{matterId}/documents/files/{fileId}/history
Get file history on a matter
GetFileHistory 2 params → 200403
POST
/matters/{matterId}/documents/files/bulk
Add files to a matter
BulkAddFiles 1 param body → 202400
GET
/matters/{matterId}/documents/files/{fileId}/preview
Get preview info for a file
GetPreview 2 params → 200400403404
POST
/matters/{matterId}/documents/files/{fileId}/preview
Create a preview request
CreatePreview 2 params → 202400403404
GET
/matters/{matterId}/documents/files/{fileId}/preview/{documentVersionId}
Get preview info for a file by document version
GetPreviewById 3 params → 200400403404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are File (23 properties), FileFolderLogEntry (20 properties), FilePagedCollection (13 properties), AddFileDto (7 properties). Each schema is shown below with its type and property counts.

FileFolderLogEntry
object
Represents a single file/folder activity (rename, move, delete, etc.).
20 properties
EditFileDto
object
5 properties 1 required
AddFileDto
object
7 properties 1 required
FilePagedCollection
object
13 properties
DownloadFileInfo
object
6 properties
File
object
23 properties
FileFolderLogEntryCollection
object
6 properties
Link
object
4 properties
ProblemDetails
object
5 properties
PreviewFileInfo
object
4 properties
UploadFileInfo
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

smokeball-files-api-openapi.yml Raw ↑

Other APIs Smokeball publishes across the network.

Smokeball Activity Codes API
Smokeball Authorization API
Smokeball Bank Accounts API
Smokeball Contacts API
Smokeball Events API
Smokeball Expenses API
Smokeball Fees API
Smokeball Firm API
Smokeball Folders API
Smokeball Intake API
Smokeball Integrated Search API
Smokeball Invoices API
Where this information came from

This is an independent, third-party profile of Smokeball Files API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.