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

Opply Files API

The Files API from Opply — 12 operation(s) for files.

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

Tagged areas include File. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 12 paths, and defines 12 schemas. It is described by OpenAPI 3.0.3, at version 0.0.0.

Requests are made against the base URL https://api.opply.com.

12 operations 12 paths 12 schemas 7 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.0.0
Base URL
https://api.opply.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Opply Files API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 7 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Files 12
GET
/api/v1/files/{uuid}/
Get file metadata
api_v1_files_retrieve 1 param → 200404
GET
/api/v1/files/{uuid}/content/
Download file bytes
api_v1_files_content_retrieve 1 param → 200413404
GET
/api/v1/files/{uuid}/url/
Get a short-lived signed download URL
api_v1_files_url_retrieve 1 param → 200404
POST
/api/v1/files/attachments/
[staff] Mint a pending attachment + presigned upload
api_v1_files_attachments_create body → 201
GET
/api/v1/files/attachments/{uuid}/
[staff] Get an attachment's scan status
api_v1_files_attachments_retrieve 1 param → 200404
POST
/api/v1/files/attachments/{uuid}/confirm/
[staff] Confirm upload (drives the scan-disabled promotion)
api_v1_files_attachments_confirm_create 1 param → 200404
GET
/api/v1/files/attachments/{uuid}/url/
[staff] Get a presigned download URL
api_v1_files_attachments_url_retrieve 3 params → 200404409
POST
/api/v1/files/message-attachments/
Mint a pending message attachment + presigned upload
api_v1_files_message_attachments_create body → 201
GET
/api/v1/files/message-attachments/{uuid}/
Get a message attachment's scan status
api_v1_files_message_attachments_retrieve 1 param → 200404
POST
/api/v1/files/message-attachments/{uuid}/confirm/
Confirm upload (drives the scan-disabled promotion)
api_v1_files_message_attachments_confirm_create 1 param → 200404
GET
/api/v1/files/message-attachments/{uuid}/url/
Get a presigned download URL
api_v1_files_message_attachments_url_retrieve 3 params → 200404409
POST
/api/v1/files/upload/
Handle file upload requests. filename = Name of the file being uploaded modelname = Name of the model related to this file. eg. for chats it would be 'Message' fieldname = Name of the field on the mo…
api_v1_files_upload_create body → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AttachmentCreateResponse (8 properties), FileTooLarge (7 properties), AttachmentStatus (7 properties), FileSignedUrl (7 properties). Each schema is shown below with its type and property counts.

AttachmentCreateResponse
object
Status fields plus the presigned POST to upload the bytes with.
8 properties 8 required
AttachmentDownloadUrl
object
A short-lived presigned GET URL for a downloadable attachment.
2 properties 2 required
FileUploadResponse
object
3 properties 3 required
FileSignedUrl
object
Returned by GET /api/v1/files/ /url/ — metadata + a short-lived signed download URL.
7 properties 7 required
FileMetadata
object
Metadata payload returned by GET /api/v1/files/ /.
5 properties 5 required
FileUpload
object
5 properties 5 required
AttachmentScanStatusEnum
string
pending - Pending scan clean - Clean malicious - Malicious failed - Scan failed skipped - Scan skipped
PresignedPost
object
The presigned POST the browser uploads the bytes with.
2 properties 2 required
AttachmentStatus
object
Read view of an Attachment row's lifecycle state.
7 properties 7 required
AttachmentTestCreate
object
Request body for minting a pending attachment.
3 properties 2 required
FileTooLarge
object
413 response from GET /api/v1/files/ /content/ when the file exceeds the inline cap — points the caller at the /url/ action.
7 properties 7 required
MessageAttachmentCreate
object
Request body for minting an unbound message attachment. No companyuuid / entity — the attachment is created unbound and scoped to the caller's company; it is b…
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-files-api-openapi.yml Raw ↑

Other APIs Opply publishes across the network.

Opply Activity Feed API
Opply Admin panel API
Opply Agents API
Opply Agreements API
Opply api API
Opply App Orders API
Opply Brain API
Opply Brands API
Opply Buyer Documents API
Opply Buyer Financial Documents API
Opply Buyer Onboarding API
Opply Buyer self-onboarding API
Where this information came from

This is an independent, third-party profile of Opply 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.