openapi: 3.2.0 info: title: PDF Services PDF To Markdown API description: "

" version: '' servers: - url: https://pdf-services-ue1.adobe.io - url: https://pdf-services-ew1.adobe.io tags: - name: PDF To Markdown description: Extract content from PDF documents and output it in a well-formatted LLM-friendly Markdown text, along with tables and figures paths: /operation/pdftomarkdown: post: tags: - PDF To Markdown summary: Extract content from PDF documents and output it in a markdown format, along with tables and figures description: "Extract PDF Content, Tables content and Tables/Figures renditions from a PDF document. Various available options are: \n\n1. Extract figures or images in base64 format" operationId: pdfoperations.pdftomarkdown parameters: - name: Authorization in: header description: Bearer + Token (Learn more about getting the access token) required: true schema: type: string - name: x-api-key in: header description: The clientId from the generated credentials required: true schema: type: string requestBody: description: Params for PDF to Markdown Operation. Refer to the External Section below for using external storage with PDF to Markdown Operation. content: application/json: schema: oneOf: - $ref: '#/components/schemas/PDFToMarkdownInternal' - $ref: '#/components/schemas/PDFToMarkdownExternal' required: true responses: '201': description: Request creation for the operation and status uri generated, which can be found in the 'location' header. headers: location: description: Job status URI for polling the results schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string '400': description: Bad Request. The request was invalid or cannot be otherwise served. headers: content-type: description: The content type of the POST API call response schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string content: application/json: schema: $ref: '#/components/schemas/400' '404': description: Resource Not Found. headers: content-type: description: The content type of the POST API call response schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string content: application/json: schema: $ref: '#/components/schemas/404' '401': description: Unauthorized. headers: content-type: description: The content type of the error JSON response. schema: type: string x-server: description: The name and version of the server. schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string content: application/json: schema: $ref: '#/components/schemas/401' '429': description: Caller doesn't have sufficient quota for this operation. headers: content-type: description: The content type of the POST API call response schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string content: application/json: schema: $ref: '#/components/schemas/429' '500': description: Internal Server Error. The server has encountered an error and is unable to process your request at this time. headers: content-type: description: The content type of the POST API call response schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string content: application/json: schema: $ref: '#/components/schemas/500' x-codegen-request-body-name: body /operation/pdftomarkdown/{jobID}/status: get: tags: - PDF To Markdown summary: Poll the PDF to markdown job for completion operationId: pdfoperations.pdftomarkdown.jobstatus parameters: - name: jobID in: path description: Job ID of the request required: true schema: type: string - name: Authorization in: header description: Bearer + Token (Learn more about getting the access token) required: true schema: type: string - name: x-api-key in: header description: The clientId from the generated credentials required: true schema: type: string responses: '200': description: A response with job information. headers: content-type: description: The content type of the status call response. schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PDFToMarkdownJobStatus' '400': description: Bad Request. The request was invalid or cannot be otherwise served. headers: content-type: description: The content type of the status call response schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Status400' '404': description: Resource Not Found. headers: content-type: description: The content type of the POST API call response schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Satus404' '401': description: Unauthorized. headers: content-type: description: The content type of the POST API call response schema: type: string x-server: description: The name and version of the server. schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Satus401' '429': description: Caller doesn't have sufficient quota for this operation. headers: content-type: description: The content type of the POST API call response schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Satus429' '500': description: Internal Server Error. The server has encountered an error and is unable to process your request at this time. headers: content-type: description: The content type of the POST API call response schema: type: string x-request-id: description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Satus500' components: schemas: done: title: done oneOf: - $ref: '#/components/schemas/internal' - $ref: '#/components/schemas/externalstatus' Satus404: properties: error: type: object properties: code: description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. type: string message: description: "An English language string that contains more information about the error. \n\n
codemessage
NOT_FOUNDJob not found.
" type: string example: error: code: NOT_FOUND message: Job not found. '400': properties: error: type: object properties: code: description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. type: string message: description: "An English language string that contains more information about the error. \n\n
codemessage
BAD_REQUESTBad Request.
" type: string example: error: code: BAD_REQUEST message: Bad Request. '500': properties: error: type: object properties: code: description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. type: string message: description: "An English language string that contains more information about the error. \n\n
codemessage
INTERNAL_SERVER_ERRORThere was an error processing your request.
UNKNOWNUnknown error.
" type: string example: error: code: INTERNAL_SERVER_ERROR message: There was an error processing your request. external: title: External with an output URI in the request description: Response in case of 'done' status using signed urls type: object properties: status: description: Job Status type: string enum: - done example: status: done externaldonewithoutoutput: title: External without an output URI in the request description: Response in case of 'done' status type: object properties: status: description: Job Status type: string enum: - done asset: $ref: '#/components/schemas/responseAsset' example: status: done asset: metadata: type: application/pdf size: 200791 downloadUri: https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=REDACTED_AWS_ACCESS_KEY_ID%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56 assetID: urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718 PDFToMarkdownInternal: title: Internal description: Params for PDF to Markdown Operation type: object required: - assetID properties: assetID: description: A file assetID. For more details click here . type: string getFigures: description: Extract figures or images in base64 format type: boolean default: 'false' notifiers: $ref: '#/components/schemas/notifiers' example: assetID: urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718 getFigures: false notifiers: - type: CALLBACK data: url: https://dummy.callback.org/ headers: x-api-key: dummykey access-token: dummytoken additionalProperties: false '404': properties: error: type: object properties: code: description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. type: string message: description: "An English language string that contains more information about the error. \n\n
codemessage
NOT_FOUNDAsset not found.
" type: string example: error: code: NOT_FOUND message: Asset not found. ExternalStorageInput: title: Input description: Params representing input object. type: object properties: uri: description: Input file Download Signed URI. type: string storage: description: Specifies the type of the external storage type: string enum: - S3 - SHAREPOINT - DROPBOX - BLOB required: - uri failed: description: Response in case of 'failed' status type: object properties: status: description: Job Status type: string enum: - failed error: type: object properties: status: description: Http status code returned by the service type: integer code: description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. type: string message: description: "An English language string that contains more information about the error. \n\n
statuscodemessage
400CORRUPT_DOCUMENTFor $(format) mime-type The input file appears to be corrupted and cannot be processed.
400PASSWORD_PROTECTEDSource file is protected and cannot be processed.
500INTERNAL_SERVER_ERRORThere was an error processing your request.
" type: string example: status: failed error: status: 500 code: INTERNAL_SERVER_ERROR message: There was an error processing your request externalstatus: title: External oneOf: - $ref: '#/components/schemas/externaldonewithoutoutput' - $ref: '#/components/schemas/external' ExternalStorageOutput: title: Output description: Params representing output object type: object properties: uri: description: Output file Upload Signed URI. type: string storage: description: Specifies the type of the external storage type: string enum: - S3 - SHAREPOINT - DROPBOX - BLOB '429': properties: error: type: object properties: code: description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. type: string message: description: "An English language string that contains more information about the error. \n\n
codemessage
TOO_MANY_REQUESTSToo Many Requests.
INSUFFICIENT_QUOTAEither Quota for this operation is not available or Free trial quota is exhausted. Please visit (www.adobe.com/go/pdftoolsapi_home) to start using free trial quota or (www.adobe.com/go/pdftoolsapi_err_quota) to upgrade to paid credentials.
" type: string example: error: code: TOO_MANY_REQUESTS message: Too Many Requests. Status400: properties: error: type: object properties: code: description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. type: string message: description: "An English language string that contains more information about the error. \n\n
codemessage
INVALID_JOB_IDInvalid job id present in path param.
" type: string example: error: code: INVALID_JOB_ID message: Invalid job id present in path param. PDFToMarkdownJobStatus: oneOf: - $ref: '#/components/schemas/inprogress' - $ref: '#/components/schemas/done' - $ref: '#/components/schemas/failed' inprogress: description: Response in case of 'in progress' status type: object properties: status: description: Job Status type: string enum: - in progress example: status: in progress PDFToMarkdownExternal: title: External description: Params for PDF to Markdown Operation using external storage. type: object required: - input properties: input: $ref: '#/components/schemas/ExternalStorageInput' output: $ref: '#/components/schemas/ExternalStorageOutput' params: description: Params for PDF to Markdown processing type: object properties: getFigures: description: Extract figures or images in base64 format type: boolean default: 'false' notifiers: $ref: '#/components/schemas/notifiers' example: input: uri: https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=REDACTED_AWS_ACCESS_KEY_ID%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2 storage: S3 output: uri: https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=REDACTED_AWS_ACCESS_KEY_ID%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71 storage: S3 params: getFigures: true notifiers: - type: CALLBACK data: url: https://dummy.callback.org/ headers: x-api-key: dummykey access-token: dummytoken additionalProperties: false responseAsset: title: asset description: Details of output asset document. For more details click here . type: object properties: metadata: type: object description: metadata details of output asset. properties: size: description: The size of the Resource in bytes. This value helps in making range requests. type: integer type: description: The media type of the Resource. type: string assetID: description: An asset ID identifying an asset that is globally unique and never reused. type: string required: false downloadUri: description: The URL used to download the Resource directly to the cloud provider. type: string example: status: done asset: metadata: type: application/pdf size: 200791 downloadUri: https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=REDACTED_AWS_ACCESS_KEY_ID%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56 assetID: urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718 Satus429: properties: error_code: description: 'The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. ' type: string message: description: "An English language string that contains more information about the error. \n\n
codemessage
429001Service usage limit reached
429002Developer key usage limit reached
429050Too many requests
" type: string example: error_code: '429050' message: Too many requests notifiers: description: Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation. type: array items: properties: type: description: Specifies the notifier type. Currently supported value is "CALLBACK" only. type: string data: description: Specifies the data needed to invoke the notifier. type: object required: - type - data Satus401: properties: error: type: object properties: code: description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. type: string message: description: "An English language string that contains more information about the error. \n\n
codemessage
UNAUTHORIZEDNot authorised to perform the operation.
" type: string example: error: code: UNAUTHORIZED message: Not authorised to perform the operation. '401': properties: error: type: object properties: code: description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. type: string message: description: "An English language string that contains more information about the error. \n\n
codemessage
UNAUTHORIZEDNot authorised to perform the operation.
" type: string example: error: code: UNAUTHORIZED message: Not authorised to perform the operation. internal: title: Internal description: Response in case of 'done' status type: object properties: status: description: Job Status type: string enum: - done asset: $ref: '#/components/schemas/responseAsset' example: status: done asset: metadata: type: application/pdf size: 200791 downloadUri: https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=REDACTED_AWS_ACCESS_KEY_ID%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56 assetID: urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718 Satus500: properties: error: type: object properties: code: description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. type: string message: description: "An English language string that contains more information about the error. \n\n
codemessage
INTERNAL_SERVER_ERRORThere was an error processing your request.
UNKNOWNUnknown error.
" type: string example: error: code: INTERNAL_SERVER_ERROR message: There was an error processing your request. x-tagGroups: - name: Authentication tags: - Generate Token - name: Files tags: - Assets - name: PDF Operations tags: - Combine PDF - Compress PDF - Create PDF - Document Generation - Export PDF - Export PDF Form Data - Extract PDF - Html to PDF - Import PDF Form Data - Linearize PDF - OCR - Page Manipulation - PDF Accessibility Auto-Tag - PDF Accessibility Checker - PDF Electronic Seal - PDF Properties - PDF To Images - PDF To Markdown - PDF Watermark - Protect PDF - Remove Protection - Split PDF