REST API Reference
General Documents
Generate A general document from Markdown
POST
/
v1
/
document
/
general
/
markdown
Copy
curl --request POST \
--url https:api.markdown2pdf.ai/v1/document/general/markdown \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"text_body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget lobortis ante, scelerisque tristique lacus. Morbi ornare vel quam sed.",
"meta": {
"author": "John Doe",
"title": "Hello World",
"date": "25 January 2025",
"subtitle": "Subtitle",
"disclaimer": "This is the disclaimer"
}
},
"options": {
"delivery": {
"method": "email",
"to_email": "backend@serendipityai.co.uk"
}
}
}'
Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "Generating live briefing for topic 'a1Gb0000005LWrfEAG'",
"status": "Processing",
"status_meta": "document_generation_started",
"progress": 0.5,
"path": "/path/to/job-poll/or/job-retrieve/endpoint"
}
Authorizations
The token generated when a user logs in
Body
application/json
Response
200
application/json
Successful Response
The response is of type object
.
Copy
curl --request POST \
--url https:api.markdown2pdf.ai/v1/document/general/markdown \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"text_body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget lobortis ante, scelerisque tristique lacus. Morbi ornare vel quam sed.",
"meta": {
"author": "John Doe",
"title": "Hello World",
"date": "25 January 2025",
"subtitle": "Subtitle",
"disclaimer": "This is the disclaimer"
}
},
"options": {
"delivery": {
"method": "email",
"to_email": "backend@serendipityai.co.uk"
}
}
}'
Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "Generating live briefing for topic 'a1Gb0000005LWrfEAG'",
"status": "Processing",
"status_meta": "document_generation_started",
"progress": 0.5,
"path": "/path/to/job-poll/or/job-retrieve/endpoint"
}
Assistant
Responses are generated using AI and may contain mistakes.