Upload

OpenAPI V2

Uploads a document to the AskYourPDF service.

post

Uploads the digital report to chat with.

Authorizations

Header parameters

x-api-versionstringrequired

ApplicationNameanyoptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyoptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyoptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyoptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyoptional

Business Identification Number (BIN) of the customer.

ClientNameanyoptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyoptional

Business Identification Number (BIN) of the client.

Body

documentContentstring · byte | nullableoptional

The PDF or XBRL file represented as Base64

Example: PD94bWwgdmVyc...

documentNamestring | nullableoptional

The name of your PDF document

Example: Annual report.pdf

Responses

application/json

objectoptional

application/json

post

HTTPcURLJavaScriptPython

POST /reportchat/upload HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "documentContent": "PD94bWwgdmVyc...",
  "documentName": "Annual report.pdf"
}

{
  "docId": "155c0585-8309-40b4-8de3-fd0951021d80"
}