AlayaCare File API
The File API from AlayaCare — 1 operation(s) for file.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/alayacare-file-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: 1.0.0
title: AlayaCare External Files File API
description: '**Remarks:**
Please note that the difference between a `Directory` and a `File` resource is that `Directory` requires a trailing `/` at the end of the path
**AlayaCare IDs:**
The following terms are used to reference IDs that identify resources in AlayaCare:
- id
'
servers:
- url: https://homecare.alayacare.com/ext/api/v2/files
tags:
- name: File
paths:
/client/{id}/{path}:
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: path
in: path
required: true
schema:
type: string
get:
tags:
- File
summary: Get the content of a file (download a file)
responses:
200:
description: Content of the file
400:
description: File not found
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: http status response code
example: 404
message:
type: string
description: Detail on the error
example: File "file.pdf" to delete not found
post:
tags:
- File
summary: Upload a file
description: 'Upload a file at the `path` location and create the underlying folder structure if it doesn''t exist already.
`path` **cannot** end with `/` in order to create a file based on the request body.
**Note:** This consumes `multipart form-data` as defined in the parameters below.
**Note on content attributes:** When specifying the key that references the file, the key must be set as `file` in the request in order for the API to find the file.
'
responses:
201:
description: File uploaded
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: http status response code
example: 201
name:
type: string
description: Url to the file uploaded
example: client/1002/file.pdf
400:
description: 'Bad Request: File missing
'
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: http status response code
example: 400
message:
type: string
description: Detail on the error
example: Could not find a file to upload
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
description: The file to upload
format: binary
put:
tags:
- File
summary: Copy or move a file
description: 'Copy or move a directory and create the underlying folder structure of the new location if it doesn''t already exist.
Whether the directory is moved or simply copied is defined by a `move` header that can be set to `true` (if the header is not provided, its value defaults to `false` and the `source` directory will remain).
The url of the `PUT` request is the path to the destination location.
i.e., if we have the following directories:
- `dir1/child1/`
- `dir2/child2/`
and we want to copy `child1/` inside `dir2/` (the goal is to have `dir2/child1/`), the `path` in the url of the `PUT` request has to be: `dir2/child1/`. The `source` header of the request has to be `dir1/child1/`.
A 400 response will be returned for a request to move a folder in one of its own subfolders.
'
responses:
200:
description: File copied or moved
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: http status response
example: 200
name:
type: integer
description: 'Url to the new location of the copied or moved file
'
example: client/1002/new_location.txt
400:
description: 'Bad Request: Missing `source` header
'
content:
application/json:
schema:
type: object
properties:
message:
type: object
properties:
source:
type: string
description: Detail on the error
example: The request cannot be processed without the source variable
404:
description: Source file not found
content:
application/json:
schema:
$ref: '#/components/schemas/FileNotFoundSchema'
delete:
tags:
- File
summary: Delete a file
description: Delete a file. As opposed to deleting a directory, the forced-delete header is not required to delete a single file.
responses:
204:
description: File deleted
404:
description: File not found
content:
application/json:
schema:
$ref: '#/components/schemas/FileNotFoundSchema'
components:
schemas:
FileNotFoundSchema:
type: object
properties:
code:
type: integer
description: http status response code
example: 404
message:
type: string
description: Detail on the error
example: File "file.pdf" not found