Document Structure API version 1.0

Do you have any questions? Write us an email or ask us through the feedback section.

This API is currently in a beta version! Send us some feedback and help us improve.

Response

Sample response:

{
    "status": {
        "code": "0",
        "msg": "OK",
        "credits": "8"
    },
    "title": "Margaret Hamilton (scientist) - Wikipedia",
    "abstract_list": [],
    "heading_list": [
        "Margaret Hamilton (scientist)",
        "Contents",
        "Early life[edit]",
        "SAGE Project[edit]",
        "NASA[edit]",
        "Businesses[edit]",
        "Legacy[edit]",
        "Personal life[edit]",
        "Publications[edit]",
        "See also[edit]",
        "References[edit]",
        "External links[edit]",
        "Navigation menu",
        "Apollo 11[edit]",
        "Awards[edit]",
        "Personal tools",
        "Namespaces",
        "Variants",
        "Views",
        "More",
        "Search",
        "Navigation",
        "Interaction",
        "Tools",
        "Print/export",
        "In other projects",
        "Languages"
    ],
    "emails_info": {
        "from": "",
        "to": [],
        "cc": [],
        "subject": ""
    }
}

Response fields:

Name	Description
`status`	Describes the request outcome in terms of success or failure.
`status`.`code`	Numerical value of result code. Refer to the error code catalog.
`status`.`msg`	Human-readable error code, if any, or`OK`.
`status`.`credits`	Credits consumed by the request.
`status`.`remaining_credits`	Credits left to reach the usage limit.
`title`	Title extracted from the document. The order of precedence for title selection is the following: `<title>`, if it doesn't exist, and the first element of the document is a heading, then the heading is considered the title. If no title or heading exists, it tries to determine if the first paragraph of the document has a title format (length, relative length and capitalization).
`heading_list`	Takes into account all the heading tags found in the text, as well as paragraphs that follow what can be considered a title format (length, relative length and capitalization).
`abstract_list`	It will include the pieces of text than include abstract markers such asabstract, introduction, overview or summary.
`emails_info`	This element will contain different sections of an email
`emails_info`.`from`	String with the sender
`emails_info`.`to`	Array of strings with all the contacts the email is sent to.
`emails_info`.`cc`	Array of strings with all the contacts in copy in the email.
`emails_info`.`subject`	String with the subject of the email.