The Document API from Alleva — 6 operation(s) for document.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/alleva-document-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
title: Alleva Rest Document API
version: '1.0'
security:
- Bearer: []
tags:
- name: Document
paths:
/documents:
post:
tags:
- Document
parameters:
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
summary: Create documents
x-summary-source: derived
operationId: postDocuments
x-operation-id-source: derived
get:
tags:
- Document
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
summary: Get documents
x-summary-source: derived
operationId: getDocuments
x-operation-id-source: derived
/v{version}/documents:
post:
tags:
- Document
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
summary: Create v{version} documents
x-summary-source: derived
operationId: postV{version}Documents
x-operation-id-source: derived
get:
tags:
- Document
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
type: string
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
summary: Get v{version} documents
x-summary-source: derived
operationId: getV{version}Documents
x-operation-id-source: derived
/documents/{id}:
patch:
tags:
- Document
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
summary: Update documents by id
x-summary-source: derived
operationId: patchDocumentsById
x-operation-id-source: derived
delete:
tags:
- Document
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
summary: Delete documents by id
x-summary-source: derived
operationId: deleteDocumentsById
x-operation-id-source: derived
get:
tags:
- Document
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
summary: Get documents by id
x-summary-source: derived
operationId: getDocumentsById
x-operation-id-source: derived
/v{version}/documents/{id}:
patch:
tags:
- Document
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
summary: Update v{version} documents by id
x-summary-source: derived
operationId: patchV{version}DocumentsById
x-operation-id-source: derived
delete:
tags:
- Document
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
summary: Delete v{version} documents by id
x-summary-source: derived
operationId: deleteV{version}DocumentsById
x-operation-id-source: derived
get:
tags:
- Document
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/Document'
summary: Get v{version} documents by id
x-summary-source: derived
operationId: getV{version}DocumentsById
x-operation-id-source: derived
/documents/type:
get:
tags:
- Document
parameters:
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/DocumentTypeModal'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/DocumentTypeModal'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/DocumentTypeModal'
summary: Get documents type
x-summary-source: derived
operationId: getDocumentsType
x-operation-id-source: derived
/v{version}/documents/type:
get:
tags:
- Document
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/DocumentTypeModal'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/DocumentTypeModal'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/DocumentTypeModal'
summary: Get v{version} documents type
x-summary-source: derived
operationId: getV{version}DocumentsType
x-operation-id-source: derived
components:
schemas:
ResourceLink:
type: object
properties:
id:
type: integer
format: int32
route:
type:
- string
- 'null'
additionalProperties: false
DocumentTypeModal:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
additionalProperties: false
Document:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
clientDocumentId:
type: integer
format: int64
name:
type:
- string
- 'null'
description:
type:
- string
- 'null'
fileName:
type:
- string
- 'null'
client:
$ref: '#/components/schemas/ResourceLink'
status:
type:
- string
- 'null'
type:
type:
- string
- 'null'
typeId:
type:
- integer
- 'null'
format: int64
uploadDate:
type:
- string
- 'null'
format: date-time
url:
$ref: '#/components/schemas/DocumentUrl'
tableId:
type:
- integer
- 'null'
format: int64
tableName:
type:
- string
- 'null'
path:
type:
- string
- 'null'
documentTypeId:
type: integer
format: int32
uploadedDocuments:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/DocumentData'
additionalProperties: false
ExternalData:
type: object
properties:
externalId:
type:
- string
- 'null'
externalIdType:
type:
- string
- 'null'
serviceIdentifier:
type:
- string
- 'null'
serviceId:
type:
- integer
- 'null'
format: int32
additionalProperties: false
DocumentData:
type: object
properties:
id:
type: integer
format: int64
name:
type:
- string
- 'null'
base64String:
type:
- string
- 'null'
externalId:
$ref: '#/components/schemas/ExternalData'
additionalProperties: false
DocumentUrl:
type: object
properties:
fileName:
type:
- string
- 'null'
host:
type:
- string
- 'null'
readOnly: true
path:
type:
- string
- 'null'
readOnly: true
additionalProperties: false
securitySchemes:
Bearer:
type: apiKey
description: "JWT Authorization header using the Bearer scheme. \n\n Enter Bearer [space] and then your token in the text input below.\n\nExample: Bearer 12345abcdef"
name: Authorization
in: header