SpinVox API Specification - The Paginator

SpinVox Create – Developers’ Guide/Prepared by: SpinVox/Date: 31-03-09
PUBLIC/©SpinVox Ltd 2009/Version: 1.0
CONTENTS
CONTENTS 2
1 INTRODUCTION 3
1.1 ABOUT SPINVOX .................................................................................................................. 3
1.2 ABOUT THE CREATE PROGRAMME ...................................................................................... 3
1.3 ABOUT VOICE TO TEXT CONVERSION ................................................................................. 4
2 QUICK START 5
3 CONNECTING TO THE SPINVOX API SERVER 6
3.1 API DESTINATION ................................................................................................................ 6
3.2 HTTPS CONFIGURATION .................................................................................................... 6
3.3 AUTHENTICATION ................................................................................................................. 6
4 SUBMITTING CONVERSION REQUESTS 7
4.1 CONVERSION REQUEST FORMAT ........................................................................................ 7
4.1.1 Standard HTTP Headers 7
4.1.2 Content Headers 7
4.1.3 XML File Details 8
4.1.4 XML File Contents 8
4.1.5 Audio File Details 11
4.1.6 Example Conversion Request 12
4.2 MESSAGE THROUGHPUT ................................................................................................... 13
4.3 HTTP RESPONSE FORMAT ............................................................................................... 13
4.3.1 HTTP header values 13
4.3.2 Successful Conversion Requests 13
4.3.3 X-Error header values 14
4.3.4 Example HTTP Responses 15
5 RETRIEVING CONVERTED TEXT FROM THE SPINVOX API 16
5.1 HIGH LEVEL OVERVIEW ..................................................................................................... 16
5.2 CONVERSION RETRIEVAL REQUEST FORMAT ................................................................... 16
5.2.1 HTTP Headers 16
5.2.2 XML File Contents 17
5.2.3 Example Conversion Responses from SpinVox API Server 19
6 GLOSSARY 21
APPENDIX A – XML SCHEMA 22
APPENDIX B – FREQUENTLY ASKED QUESTIONS 24
APPENDIX C – CHANGE LOG 26
2 / 26