Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Netter

Netter files API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Netter files API is one of 44 APIs that Netter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include files. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 17 operations across 12 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against the base URL https://api.netter.ai.

17 operations 12 paths 23 schemas 2 DELETE7 GET3 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.netter.ai
Resource Areas
1

Paths & Operations 17

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

files 17
GET
/api/v1/files/magic-links
List Magic Links
list_magic_links_api_v1_files_magic_links_get → 200
POST
/api/v1/files/magic-links
Create Magic Link
create_magic_link_api_v1_files_magic_links_post body → 201422
PATCH
/api/v1/files/magic-links/{link_id}
Update Magic Link
update_magic_link_api_v1_files_magic_links__link_id__patch 1 param body → 200422
DELETE
/api/v1/files/magic-links/{link_id}
Delete Magic Link
delete_magic_link_api_v1_files_magic_links__link_id__delete 1 param → 204422
GET
/api/v1/files/upload/{token}/meta
Get Magic Link Meta
get_magic_link_meta_api_v1_files_upload__token__meta_get 1 param → 200422
POST
/api/v1/files/upload/{token}
Magic Upload
magic_upload_api_v1_files_upload__token__post 1 param body → 201422
POST
/api/v1/files/upload
Upload File
upload_file_api_v1_files_upload_post body → 201422
POST
/api/v1/files/{user_file_id}/commit
Commit User File
commit_user_file_api_v1_files__user_file_id__commit_post 1 param body → 200422
GET
/api/v1/files/{user_file_id}/parse-config
Get Parse Config
get_parse_config_api_v1_files__user_file_id__parse_config_get 1 param → 200422
PATCH
/api/v1/files/{user_file_id}/parse-config
Patch Parse Config
patch_parse_config_api_v1_files__user_file_id__parse_config_patch 1 param body → 200422
GET
/api/v1/files/
List User Files
list_user_files_api_v1_files__get 1 param → 200422
GET
/api/v1/files/search
Search Files
search_files_api_v1_files_search_get 2 params → 200422
GET
/api/v1/files/{file_id}
Get User File
get_user_file_api_v1_files__file_id__get 1 param → 200422
DELETE
/api/v1/files/{file_id}
Delete User File
delete_user_file_api_v1_files__file_id__delete 1 param → 204422
PATCH
/api/v1/files/{file_id}
Rename User File
rename_user_file_api_v1_files__file_id__patch 1 param body → 200422
GET
/api/v1/files/{file_id}/download
Download User File
download_user_file_api_v1_files__file_id__download_get 1 param → 200422
POST
/api/v1/files/{file_id}/move
Move User File Endpoint
move_user_file_endpoint_api_v1_files__file_id__move_post 1 param body → 200422

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are UserFileSearchResult (11 properties), MagicLinkCreated (10 properties), UserFileRead (10 properties), UserFileUploadResponse (9 properties). Each schema is shown below with its type and property counts.

FileSearchResponse
object
Company-wide file/folder name-search results.
2 properties
FileFolderSearchResult
object
A folder search hit — folder identity plus the path of its parent chain. Deliberately does NOT inherit FileFolderRead: membercount / haschildren are derived pe…
7 properties 4 required
ParseConfigSheet
object
Per-sheet info for the cog modal — analyzer output + current Database.
6 properties
MagicLinkMeta
object
Public view of a magic link — no token field.
5 properties 5 required
DatabaseStub
object
Minimal Database summary returned alongside a UserFile on upload. The full Database row is filled in asynchronously by the parse workflow. Frontend uses refres…
3 properties 3 required
Body_magic_upload_api_v1_files_upload__token__post
object
2 properties 1 required
MagicLinkRead
object
9 properties 9 required
UserFileRename
object
Request payload for PATCH /files/{id}.
1 property 1 required
UserFileSearchResult
object
A file search hit — a UserFileRead plus the path of its containing folder.
11 properties 9 required
MagicLinkUpdate
object
3 properties
UserFileRead
object
10 properties 9 required
SheetAnalysis
object
Per-sheet analyzer output served by the upload wizard. For CSV the wizard returns exactly one entry with name=None. For xlsx/xlsm, one entry per sheet in workb…
5 properties
UserFileUploadResponse
object
9 properties 5 required
CommitSheet
object
One entry in the commit / patch-parse-config request body.
3 properties
MagicLinkCreated
object
Returned on creation — includes the full upload URL hint.
10 properties 10 required
ValidationError
object
5 properties 3 required
CommitRequest
object
1 property 1 required
ParseConfigDatabase
object
4 properties 4 required
HTTPValidationError
object
1 property
MagicLinkCreate
object
4 properties
UserFileMove
object
POST /files/{id}/move payload — destination folder (None = root).
1 property
ParseConfigResponse
object
3 properties 3 required
Body_upload_file_api_v1_files_upload_post
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netter-files-api-openapi.yml Raw ↑

Other APIs Netter publishes across the network.

Netter actions API
AE Profile APIs.io
Netter api-keys API
AE Profile APIs.io
Netter app-chat API
AE Profile APIs.io
Netter apps API
AE Profile APIs.io
Netter apps-query API
AE Profile APIs.io
Netter assistant API
AE Profile APIs.io
Netter attributes API
AE Profile APIs.io
Netter automations API
AE Profile APIs.io
Netter chats API
AE Profile APIs.io
Netter companies API
AE Profile APIs.io
Netter dashboard-chat API
AE Profile APIs.io
Netter dashboard-data API
AE Profile APIs.io
#files
← Back to N APIs
API Details
ID
netter:netter-files-api
Base URL
https://api.netter.ai
Docs
https://netter.ai/docs/api/overview.md
Provider
Netter
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network