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

Chatwork Files API

The Files API from Chatwork — 2 operation(s) for files.

Chatwork Files API is one of 9 APIs that Chatwork 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 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.

Requests are made against a single base URL, https://api.chatwork.com/v2.

3 operations 2 paths 1 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2
Base URL
https://api.chatwork.com/v2
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Chatwork Files API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-ChatWorkToken (chatworkToken). By default, every request must be authenticated.

  • chatworkToken — API token issued from your Chatwork account settings.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Files 3
GET
/rooms/{room_id}/files
List files in a room
listRoomFiles 2 params → 200
POST
/rooms/{room_id}/files
Upload a file to a room
uploadRoomFile 1 param body → 200
GET
/rooms/{room_id}/files/{file_id}
Retrieve file metadata or download URL
getRoomFile 3 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is File (7 properties). Each schema is shown below with its type and property counts.

File
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwork-files-api-openapi.yml Raw ↑

Other APIs Chatwork publishes across the network.

Chatwork Contacts API
Chatwork Incoming Requests API
Chatwork Link API
Chatwork Me API
Chatwork Members API
Chatwork Messages API
Chatwork Rooms API
Chatwork Tasks API