Textibility API

Textibility provides a simple, REST API for extracting information from images and documents in a number of formats and generating images and documents from structured data. With a simple, clean HTTP interface and some clever processing we can quickly and easily unlock information captured in photographs and file uploads.

Authorization

Authorization to access the Textibility API is handled using the Mashape billing and authorization framework: sign up with Mashape to get an API key.

Rate Limits

The Textibility API only allows clients to make a limited number of calls in a day: this is controlled by a daily credit allocation. The default daily credit allocation is dependent on the plan selected: see https://www.mashape.com/ideasynthesis/textibility#!pricing for detailed information. Most API calls consume a single credit, but certain API calls may consume more than a single credit so the daily credit limit is an upper bound on the number of calls that may be made to the API (not an exact amount). Contact us at info@textibility.com for any questions about rate limits or if you are interested in special arrangements.

Support

You can email us at info@textibility.com if you have any questions or if there is additional support we can provide as you use the Textibility API.

Credits

Access to the Textibility API is controlled via a daily allocation of credits. The credit allocation is dependent on the plan selected: see https://www.mashape.com/ideasynthesis/textibility#!pricing for pricing information. Different API functions consume different amounts of credits as outlined below:

  • Each API call that generates a barcode consumes 1 credit.
  • Each API call that decodes a barcode from an image format consumes 1 credit; For PDF barcode decoding each A4-sized page processed consumes a single credit.
  • For PDF text extraction, 1 credit is consumed for every 5 pages (so if a PDF document is 4 pages long, it will consume 1 credit, and if it is 10 pages long it will consume 3 credits).
  • For SVG rasterization and chart rendering, 1 credit is consumed for every successful API call.

Errors and Response Codes

All API functions will return a 200 status code if the API call was successful, or a 4xx or 5xx error code if the API call failed for any reason. The HTTP status string will include the reason for the error: an additional X-Textibility-Reason header will also provide the same reason value for use in situations where access to the HTTP status string is unavailable.

Terms of Service

IdeaSynthesis Terms of Service

Thank you for using the services of IdeaSynthesis LLC ("IdeaSynthesis"). Before you begin using any of IdeaSynthesis’s applications (the "Application"), you must read and agree to these IdeaSynthesis Terms ("Terms") and the following additional terms and conditions and policies, including any future amendments (collectively, the "Agreement"):

IdeaSynthesis Privacy Policy

http://ideasynthesis.com/privacy.html

Although we may attempt to notify you when major changes are made to these Terms and policies, you should periodically review the most up-to-date versions. IdeaSynthesis may, in its sole discretion, modify or revise these Terms and policies at any time, and you agree to be bound by such modifications or revisions. If you do not accept and abide by this Agreement, you may not use the Application. In the event of an inconsistency between the Terms and the IdeaSynthesis Privacy Policy, these Terms shall control.

  1. Description of Service. The Services consist of the offerings of IdeaSynthesis applications that allow users (each a "User" or "you") to express themselves and interact with their content ("Content"). The User initiates the Service by registering with the Application website and controls all Content created through the Service. The User is responsible for all activities occurring under its username and for keeping its password secure. You understand and agree that the Service is provided to you on an AS IS and AS AVAILABLE basis. IdeaSynthesis disclaims all responsibility and liability for the availability, timeliness, security or reliability of the Service or any other client software. The Services are always evolving and the form and nature of the Services may change from time to time without prior notice to you. In addition, IdeaSynthesis may, without any liability to you, stop (permanently or temporarily) providing the Services (or any features within the Services) to you or to users generally and may not be able to provide you with prior notice.

  2. Eligibility to Use Service. If you are an individual, you must be of legal majority age in your state and be able to enter into legally binding contracts such as these Terms. IdeaSynthesis reserves the right to refuse service to anyone at any time without notice for any reason.

  3. Proper Use. You are responsible for your own use of the Service, for any Content that you create, and for any consequences thereof. You may use the Service only in compliance with all applicable local, state, national, and international laws, rules and regulations, including any laws regarding the transmission of technical data exported from your country of residence and all United States export-control laws. Violation of any of the foregoing, may result in immediate termination of this Agreement, and may subject you to state and federal penalties and other legal consequences. IdeaSynthesis reserves the right, but shall have no obligation, to investigate your use of the Service in order to (a) determine whether a violation of the Agreement has occurred or (b) comply with any applicable law, regulation, legal process or governmental request. Much of the content on the Service is provided by and is the responsibility of the persons who made such postings. IdeaSynthesis may not monitor such content and takes no responsibility for such content. Instead, IdeaSynthesis merely provides access to such content as a service to you. By its very nature, any submitted Content may be perceived as offensive, harmful, inaccurate, deceptive or otherwise inappropriate by others. We expect that you will use caution and common sense and exercise proper judgment when using the Service. IdeaSynthesis does not endorse, support, represent or guarantee the truthfulness, accuracy, or reliability of any Content. Each User bears any and all responsibility for its Content.

  4. Privacy. As a condition of using the Service, you agree to the terms of the IdeaSynthesis Privacy Policy. You agree that IdeaSynthesis may access or disclose your personal information, including the content of your communications, if IdeaSynthesis is required to do so in order to comply with any valid legal process or governmental request (such as a search warrant, subpoena, statute, or court order), or as otherwise provided in these Terms and the general IdeaSynthesis Privacy Policy. Personal information collected by IdeaSynthesis may be stored and processed in the United States or any other country in which IdeaSynthesis or any of its agents maintains facilities. By using the Service, you consent to any such transfer of information outside of your country.

  5. Use and Storage Generally. You agree that IdeaSynthesis has no responsibility or liability for the deletion of, or the failure to store or to transmit, any Content and other communications maintained by the Service. IdeaSynthesis retains the right to create limits on use and storage at our sole discretion at any time with or without notice.

  6. Content of the Service. IdeaSynthesis takes no responsibility for third-party content (including, without limitation, any viruses or other disabling features), nor does IdeaSynthesis have any obligation to monitor such third-party content. IdeaSynthesis reserves the right at all times to remove or refuse to distribute any content on the Service, such as content which violates the terms of this Agreement. IdeaSynthesis also reserves the right to access, read, preserve, and disclose any information as it reasonably believes is necessary to (a) satisfy any applicable law, regulation, legal process or governmental request, (b) enforce this Agreement, including investigation of potential violations hereof, (c) detect, prevent, or otherwise address fraud, security or technical issues, (d) respond to user support requests, or (e) protect the rights, property or safety of IdeaSynthesis, the Service, its users and the public. IdeaSynthesis will not be responsible or liable for the exercise or non-exercise of its rights under this Agreement.

  7. IdeaSynthesis’ Intellectual Property Rights. You acknowledge that IdeaSynthesis owns all right, title and interest in and to the Service, including all intellectual property rights (the "IdeaSynthesis Rights"). IdeaSynthesis Rights are protected by U.S. and international intellectual property laws. IdeaSynthesis hereby grants to you a personal, worldwide, royalty-free, non-assignable and non-exclusive license to use the software that is provided by IdeaSynthesis as part of the Services. This license is for the sole purpose of enabling you to use the Services as provided by IdeaSynthesis, as contemplated by this Agreement. You agree that you will not copy, reproduce, alter, modify, or create derivative works from the Service. You also agree that you will not use any robot, spider, other automated device, or manual process to monitor or copy any content from the Service. As described immediately below, IdeaSynthesis Rights do not include third-party content used as part of the Service, including the content of communications appearing on the Service. You may not do any of the following while accessing or using the Services: (i) access, tamper with, or use non-public areas of the Services, IdeaSynthesis’ computer systems, or the technical delivery systems of IdeaSynthesis’ providers; (ii) probe, scan, or test the vulnerability of any system or network or breach or circumvent any security or authentication measures; (iii) access or search or attempt to access or search the Services by any means (automated or otherwise) other than through our currently available, published interfaces that are provided by IdeaSynthesis (and only pursuant to those terms and conditions), unless you have been specifically allowed to do so in a separate agreement with IdeaSynthesis (NOTE: crawling the Service is permissible if done in accordance with the provisions of the robots.txt file, however, scraping the Services without the prior consent of IdeaSynthesis is expressly prohibited); (iv) forge any TCP/IP packet header or any part of the header information in any email or posting, or in any way use the Services to send altered, deceptive or false source-identifying information; or (v) interfere with, or disrupt, (or attempt to do so), the access of any user, host or network, including, without limitation, sending a virus, overloading, flooding, spamming, mail-bombing the Services, or by scripting the creation of Content in such a manner as to interfere with or create an undue burden on the Services.

  8. Your Intellectual Property Rights. IdeaSynthesis claims no ownership or control over any Content submitted, posted or displayed by you on or through IdeaSynthesis services. You or a third-party licensor, as appropriate, retain all patent, trademark and copyright to any Content you submit, post or display on or through IdeaSynthesis services and you are responsible for protecting those rights, as appropriate. By submitting, posting or displaying Content on or through IdeaSynthesis services which are intended to be available to the members of the public, you grant IdeaSynthesis a worldwide, non-exclusive, royalty-free license to reproduce, publish and distribute such Content on IdeaSynthesis services for the purpose of displaying and distributing IdeaSynthesis applications. IdeaSynthesis furthermore reserves the right to refuse to accept, post, display or transmit any Content in its sole discretion. You represent and warrant that you have all the rights, power and authority necessary to grant the rights granted herein to any Content submitted. You may be able to choose to submit, post, and display any materials on or through the Service under a public license (e.g., a Creative Commons license), whether by manually marking your materials as such or using IdeaSynthesis applications to do so. For avoidance of doubt, IdeaSynthesis is not a party to any such public license between you and any third party. Also, for avoidance of doubt, IdeaSynthesis may choose to exercise the rights granted under (a) the public license or licenses, if any, you apply to your materials or (b) this Agreement.

  9. No Resale of the Service. Unless expressly authorized in writing by IdeaSynthesis, you agree not to reproduce, duplicate, copy, sell, trade, resell or exploit for any commercial purposes (a) any portion of the Service, (b) use of the Service, or (c) access to the Service.

  10. Publicity. (a)Your Use of Our Brand Features. You may not use or permit the use of IdeaSynthesis’ trade names, trademarks, service marks, logos, domain names, and other distinctive brand features, including "IdeaSynthesis" and "IdeaSynthesis.com", except with the prior written approval of IdeaSynthesis or in compliance with such standard use guidelines as IdeaSynthesis may publish and amend from time to time. (b)Our Right to Cite You as a Reference. We may use your data, suitably anonymized, solely as a customer reference and we may display said data on our website. We will promptly discontinue such references in the event that you terminate use of the Service and notify us thereof. Additionally, we may automatically include IdeaSynthesis’ name, logo or slogan (e.g., "Driven by IdeaSynthesis") within your Content at the level of a footnote, along with your copyright notices or in a similar location.

  11. User’s Representations and Warranties. You represent and warrant that (a) all of the information provided by you to IdeaSynthesis to use the Service is correct and current; and (b) you have all necessary right, power and authority to enter into this Agreement and to perform the acts required of you hereunder.

  12. Disclaimer of Warranties. Your access to and use of the Services or any Content is at your own risk. You understand and agree that the Services is provided to you on an "AS IS" and "AS AVAILABLE" basis. Without limiting the foregoing, IDEASYNTHESIS AND ITS PARTNERS DISCLAIM ANY WARRANTIES, EXPRESS OR IMPLIED, OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. We make no warranty and disclaim all responsibility and liability for the completeness, accuracy, availability, timeliness, security or reliability of the Services or any content thereon. IdeaSynthesis will not be responsible or liable for any harm to your computer system, loss of data, or other harm that results from your access to or use of the Services, or any Content. You also agree that IdeaSynthesis has no responsibility or liability for the deletion of, or the failure to store or to transmit, any Content and other communications maintained by the Services. We make no warranty that the Services will meet your requirements or be available on an uninterrupted, secure, or error-free basis. No advice or information, whether oral or written, obtained from IdeaSynthesis or through the Services, will create any warranty not expressly made herein. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IDEASYNTHESIS AND ITS SUBSIDIARIES, AFFILIATES, MANAGERS, OFFICERS, EMPLOYEES, AGENTS, PARTNERS AND LICENSORS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR PUNITIVE DAMAGES, INCLUDING WITHOUT LIMITATION, LOSS OF PROFITS, DATA, USE, GOOD-WILL, OR OTHER INTANGIBLE LOSSES, RESULTING FROM (A) YOUR ACCESS TO OR USE OF OR INABILITY TO ACCESS OR USE THE SERVICES; (B) ANY CONDUCT OR CONTENT OF ANY THIRD PARTY ON THE SERVICES, INCLUDING WITHOUT LIMITATION, ANY DEFAMATORY, OFFENSIVE OR ILLEGAL CONDUCT OF OTHER USERS OR THIRD PARTIES; (C) ANY CONTENT OBTAINED FROM THE SERVICES; OR (D) UNAUTHORIZED ACCESS, USE OR ALTERATION OF YOUR TRANSMISSIONS OR CONTENT, WHETHER BASED ON WARRANTY, CONTRACT, TORT (INCLUDING NEGLIGENCE) OR ANY OTHER LEGAL THEORY, WHETHER OR NOT IDEASYNTHESIS HAS BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGE, AND EVEN IF A REMEDY SET FORTH HEREIN IS FOUND TO HAVE FAILED OF ITS ESSENTIAL PURPOSE. Some jurisdictions do not allow the exclusion of certain warranties or the exclusion or limitation of liability for consequential or incidental damages, so the limitations above may not apply to you.

  13. Termination; Suspension. IdeaSynthesis may, in its sole discretion, at any time and for any reason, terminate the Service, terminate this Agreement, or suspend or terminate your account. In the event of termination, your account will be disabled and you may not be granted access to your account or any files or other content contained in your account although residual copies of information may remain in our system for some time for back-up purposes. If we terminate the Service or your account for any reason other than your breach of this Agreement (as determined by IdeaSynthesis), we will refund to you any amount that you have pre-paid for Services not yet performed or periods of time not yet elapsed. Sections 12 and 14 - 19 of these Terms (including the section regarding limitation of liability), shall survive expiration or termination.

  14. Indemnification. You agree to hold harmless and indemnify IdeaSynthesis, and its subsidiaries, affiliates, managers, officers, agents, employees and members from and against any third-party claim arising from or in any way related to your use of the Service, including any liability or expense arising from all claims, losses, damages (actual and consequential), suits, judgments, litigation costs and attorneys’ fees, of every kind and nature. In such a case, IdeaSynthesis will provide you with written notice of such claim, suit or action.

  15. Copyright Information. IdeaSynthesis respects the intellectual property rights of others and expects users of the Services to do the same. We will respond to notices of alleged copyright infringement that comply with applicable law and are properly provided to us. If you believe that any content on our website or provided through the Services has been copied in a way that constitutes copyright infringement, please provide us with the following information: (i) a physical or electronic signature of the copyright owner or a person authorized to act on their behalf; (ii) identification of the copyrighted work claimed to have been infringed; (iii) identification of the material that is claimed to be infringing or to be the subject of infringing activity and that is to be removed or access to which is to be disabled, and information reasonably sufficient to permit us to locate the material; (iv) your contact information, including your address, telephone number, and an email address; (v) a statement by you that you have a good faith belief that use of the material in the manner complained of is not authorized by the copyright owner, its agent, or the law; and (vi) a statement that the information in the notification is accurate, and, under penalty of perjury, that you are authorized to act on behalf of the copyright owner. We reserve the right to remove Content alleged to be infringing without prior notice and at our sole discretion. In appropriate circumstances, IdeaSynthesis will also terminate a User’s account if the User is determined to be a repeat infringer. Our designated copyright agent for notice of alleged copyright infringement appearing on the Services is: IdeaSynthesis LLC Attn: Copyright Agent 20 Park Plaza Suite 400 Boston, MA 02116 Email: copyright@ideasynthesis.com

  16. Entire Agreement; No Third-Party Beneficiaries. This Agreement constitutes the entire agreement, superseding any prior understandings, between you and IdeaSynthesis relating to your use of the Service. You also may be subject to additional terms and conditions that may apply when you use or purchase certain other IdeaSynthesis services, affiliate services, third-party content or third-party software. Nothing in this Agreement shall be deemed to confer any rights or benefits upon third parties (including end-users of Content through the Services).

  17. Waiver and Severability of Terms. IdeaSynthesis’ failure to exercise or enforce any right or provision of this Agreement shall not constitute a waiver of such right or provision. If any provision of this Agreement is found by a court of competent jurisdiction to be invalid, the parties nevertheless agree that the court should endeavor to give effect to the parties’ intentions as reflected in the provision, and the other provisions of this Agreement shall remain in full force and effect.

  18. Statute of Limitations. You agree that, regardless of any statute or law to the contrary, any claim or cause of action arising of or related to use of IdeaSynthesis applications or this Agreement must be filed within one (1) year after such claim or cause of action arose or be forever barred, except for claims for indemnification under Section 13 above.

  19. Choice of Law; Jurisdiction; Forum. This Agreement will be governed by and construed in accordance with the laws of the Commonwealth of Massachusetts, USA, without giving effect to its conflict-of-laws provisions or your actual state or country of legal domicile. Any claims, legal proceeding or litigation arising in connection with the Service will be brought solely in Suffolk County, Massachusetts, USA, and you consent to the jurisdiction of such courts.

Last 7 days, UTC

Average Latency
89ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time

Simple & Straightforward Pricing

Pay as you go. No long-term contracts.

Freemium

$0

additional fees may apply

Credits

20 / day

$0.0200 per extra

Subscribe

basic

$30.00

per month

Credits

100 / day

$0.0100 per extra

Subscribe

premium

$90.00

per month

Credits

500 / day

$0.0050 per extra

Subscribe

ultra

$270.00

per month

Credits

5,000 / day

$0.0010 per extra

Subscribe

Barcode

HTTP 200 : Decode Barcode POST/barcode/decode/{page}
						{
  "format": "QR",
  "data": "http://web.mit.edu/",
  "detail": "http://web.mit.edu/"
}						
Decode Barcode

Decodes the supplied barcode (from an PNG/GIF/JPEG image or a PDF file) and returns the barcode data. If decoding a PDF file an optional starting page number can be added to the end of the URL to specify which page to start searching for a barcode on (if not specified, the search begins on page 1 by default).


Test console
Description
Parameter
string

The URL of the image or PDF file to extract a barcode from. If this parameter is used, a request will be made to the specified URL and the Content-Type returned for that request will be used as the data type. Alternatively, if the API request includes a Content-Type header set to one of the acceptable formats (image/png, image/gif, image/jpg, image/jpeg, or application/pdf) then the request body will be used as the contents of the file.
Example: http://textibility.com/assets/img/samples/qr.png

url

Optional

HTTP 200 : binary POST/barcode/generate
Generate Barcode

Generates a barcode from specified content and returns it as a PNG/GIF/JPEG image or a PDF file.


Test console
Description
Parameter
string

The content to encode in the barcode.
Example: http://textibility.com/

content

Required

string

The mime-type of the output content. Supported formats include image/png (PNG), image/jpg (JPEG), image/gif (GIF) and application/pdf (PDF).
Example: image/png

datatype

Required

string

The width of the generated barcode. This is either a size in pixels or a size constant (for example L, S, or M for QR codes).
Example: 200px, L

width

Required

string

The type of barcode to generate.
Example: QR, PDF417, DATAMATRIX, UPCA, UPCE, EAN13, RSS14, RSSEXPANDED, CODE39, CODE93, CODE128, ITF, AZTEC, CODABAR, MAXICODE

type

Required

string

The type of error correction to use in the barcode. This is only necessary if the barcode format supports it, and is ignored otherwise.
Example: L, M, Q, H

errorcorrection

Optional

  • string – No request parameters specified

    HTTP 400
  • string – No barcode content specified

    HTTP 400
  • string – No response data type specified

    HTTP 400
  • string – No barcode type specified

    HTTP 400
  • string – No response image width specified

    HTTP 400
  • string – Invalid width specified

    HTTP 400
  • string – Invalid height specified

    HTTP 400
  • string – No QR code error correction type specified

    HTTP 400
  • string – Unsupported barcode type [<type>] specified

    HTTP 400
  • string – Unsupported output content type [<datatype>] specified

    HTTP 400

Chart

HTTP 200 : string POST/chart/bar
Render Bar Chart

Draws a simple bar chart based on the g.raphael library and return a PNG or PDF version of the chart.


Test console
Description
Parameter
string

The mime-type of the output content. Supported formats include image/png (PNG), and application/pdf (PDF).
Example: image/png

datatype

Required

number

The width of the generated chart. This is a size in pixels.
Example: 300

width

Required

number

The height of the generated chart. This is a size in pixels.
Example: 300

height

Required

number

The pixel density of the output image (for raster formats). Defaults to 90dpi.
Example: 120

dpi

Optional

string

The edge detail on the bars: can be one of soft, sharp, round, square. Defaults to square.
Example: sharp

bartype

Optional

boolean

If present, the chart will be stacked. By default, the chart is not stacked.

stacked

Optional

boolean

If present, the chart will be horizontal. By default, the chart is vertical.

horizontal

Optional

string

The background color to use on the chart. Defaults to white (#ffffff).
Example: #ff0000

backgroundcolor

Optional

string

The values to be charted. For a single series, pass a JSON array with numeric values. For stacked or multi-series charts, pass a JSON array where each member is also an array of numeric values: the members must all be the same length.
Example: [[10,20,30,40,50],[5,6,7,8,9]] or [10,20,30,40,50]

values

Required

string

The color(s) to be used for the chart. For a single series, you can pass a single color. For stacked or multi-series charts, pass an array of color values that is the same length as the values parameter.
Example: ["#202020","#ff0000"] or #202020

color

Required

string

(Not used) The chart title. Will be used in a future release.
Example: Test Chart

title

Optional

HTTP 200 : string POST/chart/gauge
Render Gauge

Creates a gauge chart and returns a PNG or PDF version of the chart.


Test console
Description
Parameter
string

The mime-type of the output content. Supported formats include image/png (PNG), and application/pdf (PDF).
Example: image/png

datatype

Required

number

The width of the generated chart. This is a size in pixels.
Example: 300

width

Required

number

The height of the generated chart. This is a size in pixels.
Example: 200

height

Required

number

The pixel density of the output image (for raster formats). Defaults to 90dpi.
Example: 240

dpi

Optional

number

The current value of the gauge.
Example: 120

value

Required

number

The minimum value of the gauge.
Example: 0

min

Required

number

The maximum value of the gauge.
Example: 240

max

Required

string

The title of the gauge chart. Defualts to a blank title.
Example: Average time (minutes)

title

Optional

string

The label to be placed under the gauge value. Defaults to a blank label.
Example: Last week's duration

label

Optional

string

Set to false to use a sector-based colors for the gauge: green if the value is less than 33% of the max, yellow if it is less than 66% of the max, and red otherwise. Defaults to true, which selects a gauge color based on the percentage of the maximum value, instead of a range.
Example: false

gradient

Optional

string

The background color to be used on the gauge line.
Example: #202020

gaugebackgroundcolor

Optional

HTTP 200 : string POST/chart/line
Render Line Chart

Draws a simple line chart based on the g.raphael library and and return a PNG or PDF version of the chart.


Test console
Description
Parameter
string

The mime-type of the output content. Supported formats include image/png (PNG), and application/pdf (PDF).
Example: image/png

datatype

Required

number

The width of the generated chart. This is a size in pixels.
Example: 300

width

Required

number

The height of the generated chart. This is a size in pixels.
Example: 300

height

Required

number

The pixel density of the output image (for raster formats). Defaults to 90dpi.
Example: 120

dpi

Optional

string

The background color to use on the chart. Defaults to white (#ffffff).
Example: #ff0000

backgroundcolor

Optional

string

(Not used) The chart title. Will be used in a future release.
Example: Test Chart

title

Optional

string

The color(s) to be used for the chart. For a single series, you can pass a single color. For multi-series charts, pass an array of color values that is the same length as the xvalues parameter.
Example: ["#202020","#0000ff"]

color

Required

string

The x-axis values to be charted. Must be a JSON array with numeric values.
Example: [10,20,30,40,50,60]

xvalues

Required

string

The y-axis values to be charted. For a single series, pass a JSON array with numeric values that is the same length as the xvalues parameters. For multi-series charts, pass a JSON array where each member is also an array of numeric values: the members must all be the same length as the xvalues parameter..
Example: [[5,7,6,8,2,1],[12,11,15,17,4,20]]

yvalues

Required

PDF

HTTP 200 : Extract Text POST/pdf/text
Represents text extracted from a single document consisting of one or more pages.
						{
  "text": [
    [
      "Southwest Airlines Boarding Pass",
      "- - - - - - - - - - - - - - - - - - - - - - - - - FOLD HERE - - - - - - - - - - - - - - - - - - - - - - - - -",
      "BOARDING PASS",
      "FLIGHT",
      "DATE",
      "CONF.#",
      "1936OMAHA",
      "ST. LOUIS",
      "06:50 AM R",
      "1435ST. LOUIS",
      "BOSTON LOGAN",
      "08:35 AM",
      "RR",
      "Check Monitors for Gate Number",
      "Boarding",
      "Group",
      "Boarding",
      "Position",
      "123456789",
      "123456",
      "LN: LASTNAME",
      "FN: FIRSTNAME",
      "MN:",
      "37",
      "AWI-XP/FF.21",
      "Southwest Airlines - Print Boarding Passes and Security Documentshttp://www.southwest.com/flight/viewCheckinDocument.html?disc=sdc:...",
      "1 of 26/22/2013 7:50 A",
      "M"
    ],
    [
      "Southwest Airlines Boarding Pass",
      "- - - - - - - - - - - - - - - - - - - - - - - - - FOLD HERE - - - - - - - - - - - - - - - - - - - - - - - - -",
      "BOARDING PASS",
      "FLIGHT",
      "DATE",
      "CONF.#",
      "1435ST. LOUIS",
      "BOSTON LOGAN",
      "08:35 AM R",
      "RR",
      "Check Monitors for Gate Number",
      "Boarding",
      "Group",
      "Boarding",
      "Position",
      "123456789",
      "123456",
      "LN: LASTNAME",
      "FN: FIRSTNAME",
      "MN:",
      "53",
      "AWI-XP/FF.21",
      "Southwest Airlines - Print Boarding Passes and Security Documentshttp://www.southwest.com/flight/viewCheckinDocument.html?disc=sdc:...",
      "2 of 26/22/2013 7:50 A",
      "M"
    ]
  ]
}						
Extract Text from PDF

Returns the text in the selected PDF file, separated by page and display line.


Test console
Description
Parameter
string

The URL of the PDF file to extract text from. If this parameter is used, a request will be made to the specified URL and the content returned for that request will be used as the data. The request MUST have a Content-Type header set to application/pdf. Alternatively, if the API request includes a Content-Type header set to application/pdf then the request body will be used as the contents of the file.
Example: http://textibility.com/assets/img/samples/text.pdf

url

Optional

  • string

    HTTP 0
HTTP 200 : binary POST/pdf/filterpages
Filter PDF Pages

Removes one or more pages from the specified PDF file.


Test console
Description
Parameter
string

The URL of the PDF file to filter specific pages from. If this parameter is used, a request will be made to the specified URL and the content returned for that request will be used as the data. The request MUST have a Content-Type header set to application/pdf. Alternatively, if the API request includes a Content-Type header set to application/pdf then the request body will be used as the contents of the file.
Example: http://textibility.com/assets/img/samples/text.pdf

url

Optional

string

A JSON array with the page numbers to be removed. The page numbers must be integers, greater than or equal to 1 and less than or equal to the total number of pages in the file. If passing the file using the POST body the page numbers can be specified using the X-Parameter-Pages header.
Example: [2,4,6,8,10]

pages

Required

HTTP 200 : string POST/pdf/thumbnails
Get Thumbnails

Obtain one or more thumbnail images representing the pages of a PDF file. If a single page is requested it will be returned as a PNG image. If multiple pages are requested then a ZIP file will be returned (with the Content-Type header of the response set to application/zip), and each image within the zip file will be named with the page number (for example, 1.png, 2.png etc).


Test console
Description
Parameter
string

The URL of the PDF file to obtain thumbnails from. If this parameter is used, a request will be made to the specified URL and the content returned for that request will be used as the data. The request MUST have a Content-Type header set to application/pdf. Alternatively, if the API request includes a Content-Type header set to application/pdf then the request body will be used as the contents of the file.
Example: http://textibility.com/assets/img/samples/text.pdf

url

Required

string

This can either be the string "all" (for all pages) or a JSON array with the specific page numbers. If using the JSON argument the page numbers must be integers, greater than or equal to 1 and less than or equal to the total number of pages in the file. If passing the file using the POST body the page numbers can be specified using the X-Parameter-Pages header.
Example: [2,4,6,8,10] or "all" (without the quotes)

pages

Required

HTTP 200 : string POST/pdf/join
Join PDF Files

Joins 2 or more PDF files into a single PDF file.


Test console
Description
Parameter
string

The URL of each PDF file to be merged: this parameter can be supplied multiple times. The merged PDF file will contain the pages of all the supplied files in the order the arguments are specified. If the Content-Type header is set to application/x-www-form-urlencoded then the parameter values will be expected to be URLs: a request will be made to each specified URL and the content returned for those requests will be used for the merge. The content returned MUST have a Content-Type header set to application/pdf. Alternatively, if the API request includes a Content-Type header set to multipart/form-data then the request body will be expected to contain each of the files to be merged.
Example: http://textibility.com/assets/img/samples/text.pdf

document

Required

HTTP 200 : binary POST/pdf/lock
Lock PDF File

Adds password encryption and access permissions to a specific file. Currently only supports RC4 encryption.


Test console
Description
Parameter
string

The URL of the PDF file to encrypt. If this parameter is used, a request will be made to the specified URL and the content returned for that request will be used as the data. The request MUST have a Content-Type header set to application/pdf. Alternatively, if the API request includes a Content-Type header set to application/pdf then the request body will be used as the contents of the file. Only RC4 encryption is currently supported.
Example: http://textibility.com/assets/img/samples/locksource.pdf

url

Optional

string

The display password to be applied to the file. If this is not set then the file can be opened without presenting any password. If passing the file using the POST body the display password can be specified using the X-Parameter-DisplayPassword header.
Example: password

displaypassword

Optional

string

The permissions password to be applied to the file. If passing the file using the POST body the permissions password can be specified using the X-Parameter-PermissionsPassword header.
Example: password

permissionspassword

Required

number

Set to 40 to use 40-bit RC4 encryption, compatible with Adobe Acrobat 3 and higher. By default (if this parameter is not specified), 128-bit RC4 encryption is used (compatible with Adobe Acrobat 5 and higher). If passing the file using the POST body the X-Parameter-EncryptionLength request header can be passed with the encryption value.
Example: 40

encryptionlength

Optional

string

A JSON array with the permissions to be configured for the user password. If this parameter is missing or is an empty array then no permissions are specified and all actions are disabled for anyone viewing the file with the user password. If passing the file using the POST body the permissions can be passed using the X-Parameter-Permissions header. Supported permissions are annotations (permit a non-owner to add/modify text annotations and fill in form fields), assemble (permit a non-owner to insert/delete/reposition pages), extract (permit a non-owner to extract text and images), extractaccessibility (permit a non-owner to extract text and images for accessibility purposes), fillform (permit a non-owner to fill in form fields), modify (permit a non-owner to modify the document), print (permit a non-owner to print the document in a degraded format), and printhigh (permit a non-owner to print the document at the highest available fidelity).
Example: ["modify","print","printhigh"]

permissions

Optional

HTTP 200 : binary POST/pdf/unlock
Unlock PDF File

Removes all password encryption and access permissions from a PDF file. Currently only supports RC4 encryption.


Test console
Description
Parameter
string

The URL of the PDF file to decrypt. If this parameter is used, a request will be made to the specified URL and the content returned for that request will be used as the data. The request MUST have a Content-Type header set to application/pdf. Alternatively, if the API request includes a Content-Type header set to application/pdf then the request body will be used as the contents of the file. Only RC4 encryption is currently supported.
Example: http://textibility.com/assets/img/samples/locksource.pdf

url

Optional

string

The owner password to use when decrypting the file. If passing the file using the POST body the owner password can be specified using the X-Parameter-Password header.
Example: pass

password

Required

SVG

HTTP 200 : string POST/svg/generate
Convert SVG

Converts an SVG document into a bitmap (PNG/JPEG/GIF) or a PDF file.


Test console
Description
Parameter
string

The content to encode in the barcode.
Example: <svg xmlns="http://www.w3.org/2000/svg" version="1.1"><circle cx="100" cy="50" r="40" stroke="black" stroke-width="2" fill="red" /></svg>

content

Required

string

The mime-type of the output content. Supported formats include image/png (PNG), image/jpg (JPEG), image/gif (GIF) and application/pdf (PDF).
Example: image/png

datatype

Required

number

The width of the page.

width

Required

number

The height of the page.

height

Optional

number

The pixel density of the output image. Defaults to 90dpi.

dpi

Optional

You must have an API key to test this API!


Mashape allows developers to find, consume, and distribute cloud APIs just like Textibility.

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.