MyLeadTech Documents API
The Documents API from MyLeadTech — 3 operation(s) for documents.
The Documents API from MyLeadTech — 3 operation(s) for documents.
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/myleadtech-app:myleadtech-app-documents-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. 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: MyLeadTech Documents API
description: 'HVAC service-manual API: resolve a model or nameplate reference, search OEM manuals, get fault-code meanings and answers cited to the manual page they came from. Authenticate with `Authorization: Bearer ` (keys at https://web.myleadtech.app). Docs: https://myleadtech.app/developers/docs'
termsOfService: https://myleadtech.app/terms
contact:
name: MyLeadTech
url: https://myleadtech.app/developers
email: hello@myleadtech.app
version: ar-00/1
servers:
- url: https://api.myleadtech.app
description: Production
tags:
- name: Documents
paths:
/v1/documents/{document_version_id}:
get:
summary: Catalog Document
operationId: get_document
parameters:
- name: document_version_id
in: path
required: true
schema:
type: string
title: Document Version Id
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'400':
description: 'Invalid request: `error.param` names the parameter to fix.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'401':
description: Credential is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'403':
description: The credential does not allow this operation.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'404':
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'429':
description: Rate limit or monthly allowance reached; see `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
minimum: 1
'503':
description: Dependency unavailable; see `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
minimum: 1
security:
- bearerAuth: []
tags:
- Documents
/v1/documents/{document_version_id}/file:
get:
summary: Catalog Fichier
description: 'Always 410: original PDFs are not distributed. Read pages as PNG images instead.'
operationId: get_document_file
parameters:
- name: document_version_id
in: path
required: true
schema:
type: string
title: Document Version Id
responses:
'400':
description: 'Invalid request: `error.param` names the parameter to fix.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'401':
description: Credential is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'403':
description: The credential does not allow this operation.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'410':
description: 'Gone: the PDF is not distributed; read pages as PNG images.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'429':
description: Rate limit or monthly allowance reached; see `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
minimum: 1
'503':
description: Dependency unavailable; see `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
minimum: 1
security:
- bearerAuth: []
tags:
- Documents
head:
summary: Catalog Fichier Tete
description: 'Always 410: original PDFs are not distributed.'
operationId: head_document_file
parameters:
- name: document_version_id
in: path
required: true
schema:
type: string
title: Document Version Id
responses:
'400':
description: 'Invalid request: `error.param` names the parameter to fix.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'401':
description: Credential is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'403':
description: The credential does not allow this operation.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'410':
description: 'Gone: the PDF is not distributed; read pages as PNG images.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'429':
description: Rate limit or monthly allowance reached; see `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
minimum: 1
'503':
description: Dependency unavailable; see `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
minimum: 1
security:
- bearerAuth: []
tags:
- Documents
/v1/documents/{document_version_id}/pages/{page_number}:
get:
summary: Page
description: 'Page or cited zone as a PNG image (the PDF is not provided). With `metadata=1` the body is JSON instead
(schema `PageMeta`, see `x-mlt-metadata-schema`); it is not listed as a response type so that generated
clients, which parse the first listed type, never try to decode an image as JSON.'
operationId: get_document_page
parameters:
- name: document_version_id
in: path
required: true
schema:
type: string
title: Document Version Id
- name: page_number
in: path
required: true
schema:
type: integer
title: Page Number
- name: format
in: query
required: false
schema:
type: string
default: png
title: Format
- name: region
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Region
- name: metadata
in: query
required: false
schema:
type: integer
default: 0
title: Metadata
responses:
'200':
description: Successful response.
content:
image/png:
schema:
type: string
format: binary
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'400':
description: 'Invalid request: `error.param` names the parameter to fix.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'401':
description: Credential is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'403':
description: The credential does not allow this operation.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'404':
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'410':
description: 'Gone: the PDF is not distributed; read pages as PNG images.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
'503':
description: Dependency unavailable; see `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/ErreurOut'
headers:
X-Request-Id:
description: Identifier of this call; the same value is in the body and in the service log.
schema:
type: string
MLT-Contract:
description: Contract version served (additive changes keep it).
schema:
type: string
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
minimum: 1
security:
- bearerAuth: []
x-mlt-metadata-schema:
$ref: '#/components/schemas/PageMeta'
tags:
- Documents
components:
schemas:
Publication:
properties:
branch:
type: string
title: Branch
snapshot_ref:
type: string
title: Snapshot Ref
type: object
required:
- branch
- snapshot_ref
title: Publication
Boite:
properties:
x0:
type: number
title: X0
y0:
type: number
title: Y0
x1:
type: number
title: X1
y1:
type: number
title: Y1
type: object
required:
- x0
- y0
- x1
- y1
title: Boite
Download:
properties:
url:
title: Url
type: string
expires_at:
title: Expires At
type: string
required:
- url
- expires_at
title: Download
type: object
DocumentOut:
properties:
request_id:
type: string
title: Request Id
contract_version:
type: string
title: Contract Version
default: catalog-v1/1
service_revision:
type: string
title: Service Revision
publication:
$ref: '#/components/schemas/Publication'
status:
type: string
title: Status
partial:
type: boolean
title: Partial
default: false
missing:
items:
type: string
type: array
title: Missing
degraded:
items:
type: string
type: array
title: Degraded
usage:
$ref: '#/components/schemas/CatalogUsage'
document_version_id:
type: string
title: Document Version Id
title:
anyOf:
- type: string
- type: 'null'
title: Title
document_type:
anyOf:
- type: string
- type: 'null'
title: Document Type
revision:
anyOf:
- type: string
- type: 'null'
title: Revision
published_on:
anyOf:
- type: string
format: date
- type: 'null'
title: Published On
language:
anyOf:
- type: string
- type: 'null'
title: Language
page_count:
anyOf:
- type: integer
exclusiveMinimum: 0.0
- type: 'null'
title: Page Count
printed_labels:
additionalProperties:
type: string
type: object
title: Printed Labels
description: numéro de page PDF -> numéro imprimé (source, jamais fabriqué)
additionalProperties: false
type: object
required:
- request_id
- service_revision
- publication
- status
- usage
- document_version_id
title: DocumentOut
Usage:
properties:
operation:
title: Operation
type: string
debited:
title: Debited
type: boolean
units:
anyOf:
- type: number
- type: 'null'
default: null
title: Units
remaining:
anyOf:
- type: number
- type: 'null'
default: null
title: Remaining
window_end:
anyOf:
- type: string
- type: 'null'
default: null
title: Window End
required:
- operation
- debited
title: Usage
type: object
Erreur:
properties:
code:
type: string
title: Code
message:
type: string
title: Message
param:
anyOf:
- type: string
- type: 'null'
title: Param
doc_url:
anyOf:
- type: string
- type: 'null'
title: Doc Url
retry_after_seconds:
anyOf:
- type: integer
- type: 'null'
title: Retry After Seconds
type: object
required:
- code
- message
title: Erreur
CatalogUsage:
properties:
operation:
type: string
title: Operation
debited:
type: boolean
title: Debited
units:
anyOf:
- type: number
- type: 'null'
title: Units
remaining:
anyOf:
- type: number
- type: 'null'
title: Remaining
window_end:
anyOf:
- type: string
- type: 'null'
title: Window End
type: object
required:
- operation
- debited
title: CatalogUsage
RegionMeta:
properties:
citation_window_id:
title: Citation Window Id
type: string
box:
$ref: '#/components/schemas/Boite'
required:
- citation_window_id
- box
title: RegionMeta
type: object
PageMeta:
properties:
request_id:
title: Request Id
type: string
contract_version:
default: ar-00/1
title: Contract Version
type: string
service_revision:
title: Service Revision
type: string
publication:
$ref: '#/components/schemas/Publication'
status:
title: Status
type: string
partial:
default: false
title: Partial
type: boolean
missing:
items:
type: string
title: Missing
type: array
degraded:
items:
type: string
title: Degraded
type: array
usage:
$ref: '#/components/schemas/Usage'
notice:
anyOf:
- type: string
- type: 'null'
default: null
title: Notice
page_id:
title: Page Id
type: string
document_version_id:
title: Document Version Id
type: string
page_number:
title: Page Number
type: integer
printed_label:
anyOf:
- type: string
- type: 'null'
default: null
title: Printed Label
format:
const: png
title: Format
type: string
mime:
title: Mime
type: string
filename:
title: Filename
type: string
byte_size:
title: Byte Size
type: integer
sha256:
title: Sha256
type: string
width_px:
anyOf:
- type: integer
- type: 'null'
default: null
title: Width Px
height_px:
anyOf:
- type: integer
- type: 'null'
default: null
title: Height Px
variant:
enum:
- full_page
- region_crop
title: Variant
type: string
region:
anyOf:
- $ref: '#/components/schemas/RegionMeta'
- type: 'null'
default: null
download:
anyOf:
- $ref: '#/components/schemas/Download'
- type: 'null'
default: null
required:
- request_id
- service_revision
- publication
- status
- usage
- page_id
- document_version_id
- page_number
- format
- mime
- filename
- byte_size
- sha256
- variant
title: PageMeta
type: object
ErreurOut:
properties:
request_id:
type: string
title: Request Id
contract_version:
type: string
title: Contract Version
default: ar-00/1
error:
$ref: '#/components/schemas/Erreur'
type: object
required:
- request_id
- error
title: ErreurOut
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: MyLeadTech API key from https://web.myleadtech.app