Run apps by SDK

Import modules and initialize the client

Import key Python modules.

1
import os
2
import time
3
4
from aihub import AIHub

Initialize a client that lets you interact with the API through Python objects and methods.

1
# initialize the SDK client
2
client = AIHub(api_root=<API-ROOT>,
3
               api_key=<API-TOKEN>,
4
               ib_context=<IB-CONTEXT>)

Parameter reference

Upload files to a batch

You can create a batch of files to use as input for your app run. You can add and remove files from the batch, but the batch ID remains constant so you can repeatedly use all files in the batch as app input. For more information, see the batches endpoint.

Below the code you wrote to initialize the client, create a batch with client.batches.create() and upload files to it with client.batches.add_file().

1
# create a batch
2
batch = client.batches.create(name=<BATCH-NAME>)
3
4
# add files to the batch
5
file_paths = [<PATH/TO/FILE1>, <PATH/TO/FILE2>]
6
for path in file_paths:
7
    with open(file_path, 'rb') as file:
8
        client.batches.add_file(batch_id=batch.id,
9
                                file_name=os.path.basename(path),
10
                                file=file)

Parameter reference

Process files through an AI Hub app

After uploading your files to a batch, you can process them using an AI Hub app. With the SDK, you can run the app, check the status of your app run, and when the run is complete, get the results. For more information, see the runs endpoint.

This section of the script runs the app with the batch you created as input, checks the status of the app run, and gets the results.

1
run = client.apps.runs.create(app_name=<APP-NAME>,
2
                              owner=<OWNER>,
3
                              batch_id=batch.id)
4
5
# repeatedly check run status until run is complete
6
status = client.apps.runs.status(run.id)
7
while status.status == 'RUNNING':
8
    time.sleep(5)  # polling interval in seconds
9
    status = client.apps.runs.status(run.id)
10
11
# get app run results
12
results = client.apps.runs.results(run.id)

Parameter reference

For more information about customizing an app run, including using webhooks, see the runs endpoint.