Skip to main content

API client for the Arkindex project

Project description

API documentation available at

arkindex-client provides an API client to interact with Arkindex servers.


Install the client using pip:

pip install arkindex-client


To create a client and login using an email/password combo, use the ArkindexClient.login helper method:

from arkindex import ArkindexClient
cli = ArkindexClient()
cli.login('EMAIL', 'PASSWORD')

This helper method will save the authentication token in your API client, so that it is reused in later API requests.

If you already have an API token, you can create your client like so:

from arkindex import ArkindexClient
cli = ArkindexClient('YOUR_TOKEN')

To perform a simple API request, you can use the request() method. The method takes an operation ID as a name and the operation’s parameters as keyword arguments:

Making requests

corpus = cli.request('RetrieveCorpus', id='...')

The result will be a Python dict containing the result of the API request. If the request returns an error, an apistar.exceptions.ErrorResponse will be raised.

Dealing with pagination

The Arkindex client adds another helper method for paginated endpoints that deals with pagination for you: ArkindexClient.paginate. This method returns a ResponsePaginator instance, which is a classic Python iterator that does not perform any actual requests until absolutely needed: that is, until the next page must be loaded.

for page in cli.paginate('ListCorpusPages', id=corpus['id']):

Warning: Using list on a ResponsePaginator may load dozens of pages at once and cause a big load on the server. You can use len to get the total item count before spamming a server.

Using another server

By default, the API client is set to point to the main Arkindex server at If you need or want to use this API client on another server, you can use the base_url keyword argument when setting up your API client:

cli = ArkindexClient(base_url='https://somewhere')

Handling errors

APIStar, the underlying API client we use, does all of the error handling. It will raise two types of exceptions:

The request resulted in a HTTP 4xx or 5xx response from the server.
Any error that prevents the client from making the request or fetching the response: invalid endpoint names or URLs, unsupported content types, or unknown request parameters. See the exception messages for more info.

You can handle HTTP errors and fetch more information about them using the exception’s attributes:

from apistar.exceptions import ErrorResponse
    # cli.request ...
except ErrorResponse as e:
    print(e.title)   # "400 Bad Request"
    print(e.status_code)  # 400
    print(e.result)  # Any kind of response body the server might give

Note that by default, using repr() or str() on those exceptions will not give any useful messages; a fix in APIStar is waiting to be merged. In the meantime, you can use Teklia’s APIStar fork:

pip install git+

This will provide support for repr() and str(), which will also enhance error messages on unhandled exceptions.

Uploading a file

The underlying API client we use does not currently handle sending anything other than JSON; therefore, the client adds a helper method to upload files to a corpus using the UploadDataFile endpoint: ArkindexClient.upload.

# Any readable file-like object is supported
with open('cat.jpg', 'rb') as f:
    cli.upload('CORPUS_ID', f)

# You can also use a path directly
cli.upload('CORPUS_ID', 'cat.jpg')

Trying to upload an existing data file will result in a HTTP 400 error that includes the existing data file’s ID, so that you can try to delete it and upload again or just reuse it.

from apistar.exceptions import ErrorResponse
    data = cli.upload('CORPUS_ID', 'cat.jpg')
    file_id = data['id']
    print('Success', file_id)
except ErrorResponse as e:
    if e.status_code != 400 or 'id' not in e.content:
    file_id = e.content['id']
    print('Already exists', file_id)

Sending XML content

Some Arkindex endpoints expect XML to be sent as the request body; to do so, use the ArkindexClient.send_xml method. This method expects a string, bytestring, or a file-like object as the body. The method works just like any other request.

cli.send_xml('SomeEndpoint', body='<xml></xml>')
cli.send_xml('SomeEndpoint', id='...', arg='...', body=b'<xml></xml>')
cli.send_xml('SomeEndpoint', body=open('file.xml'))


Create transcriptions in bulk

payload = {
    "parent": "ELEMENT_ID",
    "recognizer": "ML_TOOL_SLUG",
    "transcriptions": [
            # A polygon, as a list of at least 3 [x, y] points
            "polygon": [
                [100, 100],
                [100, 300],
                [200, 300],
                [200, 100],
            # The confidence score
            "score": 0.8,
            # Recognized text
            "text": "Blah",
            # Transcription type: page, paragraph, line, word, character
            "type": "word",
        # ...
cli.request('CreateTranscriptions', body=payload)

Import transcriptions for a page from files in PAGE XML format

cli.send_xml('ImportTranskribusTranscriptions', id='PAGE_ID', body=open('file.xml', 'rb'))

Download full logs for each Ponos task in a workflow

workflow = cli.request('RetrieveWorkflow', id='...')
for task in workflow['tasks']:
    with open(task['id'] + '.txt', 'w') as f:
        f.write(cli.request('RetrieveTaskLog', id=task['id']))

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for arkindex-client, version 0.11.2
Filename, size File type Python version Upload date Hashes
Filename, size arkindex_client-0.11.2-py3-none-any.whl (36.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size arkindex-client-0.11.2.tar.gz (34.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page