Alkymi (Preview)

Alkymi transforms enterprise workflows by placing machine learning and automation technology into the hands of business users, turning operational data headaches into a source of efficiency. Alkymi’s core products—Data Inbox and Patterns—allow businesses to extract, analyze, and take action on critical business data in emails and documents.The Alkymi connector allows you to easily access the data extracted from unstructured documents processed by the Alkymi app.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Alkymi Support
URL https://www.alkymi.io/contact
Email tori@alkymi.io
Connector Metadata
Publisher Alkymi
Website https://alkymi.io
Privacy policy https://www.alkymi.io/privacy-policy
Categories Content and Files

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True
Host Name string Your tenant's host name True

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Get Dataset Information

Retrieve a specific dataset instance. The returned dataset record may require additional parsing before using downstream in the workflow. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/dowMAn1aXoA6vyOj24fOr

Get Document File (Original Format)

Downloads a copy of the document file posted to Data Inbox in its original format.

Get Document File (PDF Format)

Downloads a copy of the document file posted to Data Inbox in a converted PDF format.

Get Document Information

Retrieve a specific document instance. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/IEdTOtMaW23SQFRPhkDXh

Get Execution Information

Retrieve a specific execution instance. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/sugkRPXlX9jwR3dDbmrdX

Get Pattern Information

Retrieve a specific pattern instance. The returned pattern record may require additional parsing before using downstream in the workflow.

Get Record Information

Retrieve a specific record instance. The returned record object may require additional parsing before using downstream in the workflow. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/HEVS5cHZTtViD4_F6BLlM

List All Datasets

Lists all of the datasets available on the tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/6VcSt63koHgyePk72r0pR

List All Documents

Lists all of the documents available on the tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7DOwvq52yx9eVF2KFpkQH

List All Executions

Lists all of the executions available on the tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7qd1-PJ-P40RFf7ocIK5g

List All Patterns

List all of the patterns available on the tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/O_NVlCnEFDOAQPWev_rdb

List All Records

Lists all of the records available on the tenant. For example, you can return all records for a specific pattern if the tenant is configured with multiple patterns. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/AxGvA5pWxls9DWOMUE1qs

Upload Document File

Uploads a file to a Data Inbox tenant for processing.

Get Dataset Information

Retrieve a specific dataset instance. The returned dataset record may require additional parsing before using downstream in the workflow. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/dowMAn1aXoA6vyOj24fOr

Parameters

Name Key Required Type Description
Dataset UUID
uuid True uuid

dataset uuid

Returns

dataset list

PaginatedDatasetList
PaginatedDatasetList

Get Document File (Original Format)

Downloads a copy of the document file posted to Data Inbox in its original format.

Parameters

Name Key Required Type Description
Document UUID
uuid True uuid

document uuid

Returns

response
binary

Get Document File (PDF Format)

Downloads a copy of the document file posted to Data Inbox in a converted PDF format.

Parameters

Name Key Required Type Description
Document UUID
uuid True uuid

document uuid

Returns

response
binary

Get Document Information

Retrieve a specific document instance. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/IEdTOtMaW23SQFRPhkDXh

Parameters

Name Key Required Type Description
Document UUID
uuid True uuid

document uuid

Returns

document

Document
Document

Get Execution Information

Retrieve a specific execution instance. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/sugkRPXlX9jwR3dDbmrdX

Parameters

Name Key Required Type Description
Execution UUID
uuid True uuid

execution uuid

Returns

execution

Execution
Execution

Get Pattern Information

Retrieve a specific pattern instance. The returned pattern record may require additional parsing before using downstream in the workflow.

Parameters

Name Key Required Type Description
Pattern Name
name True string

pattern name

Returns

pattern

PipelineConfiguration
PipelineConfiguration

Get Record Information

Retrieve a specific record instance. The returned record object may require additional parsing before using downstream in the workflow. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/HEVS5cHZTtViD4_F6BLlM

Parameters

Name Key Required Type Description
Record UUID
uuid True uuid

record uuid

Returns

record

Record
Record

List All Datasets

Lists all of the datasets available on the tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/6VcSt63koHgyePk72r0pR

Returns

dataset list

PaginatedDatasetList
PaginatedDatasetList

List All Documents

Lists all of the documents available on the tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7DOwvq52yx9eVF2KFpkQH

Returns

Name Path Type Description
count
count integer

count

next
next string

next

previous
previous string

previous

results
results array of Document

List All Executions

Lists all of the executions available on the tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7qd1-PJ-P40RFf7ocIK5g

Parameters

Name Key Required Type Description
Document Status
document_status array

document status

Returns

execution list

PaginatedExecutionList
PaginatedExecutionList

List All Patterns

List all of the patterns available on the tenant. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/O_NVlCnEFDOAQPWev_rdb

Returns

pipeline configuration list

PaginatedPipelineConfigurationList
PaginatedPipelineConfigurationList

List All Records

Lists all of the records available on the tenant. For example, you can return all records for a specific pattern if the tenant is configured with multiple patterns. https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/AxGvA5pWxls9DWOMUE1qs

Parameters

Name Key Required Type Description
Dataset UUID
dataset uuid

dataset uuid

Processing Status
document_status array

processing status

Pattern
pipeline string

pattern name

Removed Status
removed boolean

removed status

Reviewed Status
reviewed boolean

reviewed status

Schema
schema string

schema

Returns

record list

PaginatedRecordList
PaginatedRecordList

Upload Document File

Uploads a file to a Data Inbox tenant for processing.

Parameters

Name Key Required Type Description
Removed Boolean
removed boolean

removed

Dataset UUID
dataset string

dataset uuid

Subject
subject string

subject

Sender
sender string

sender

Folder
folder string

folder

File Name
file True file

file name

Targeted Patterns
targets array

targeted pattern names

Triggers

When An Alkymi Event Triggers

This trigger is executed when any of the selected Alkymi events occur.

When An Alkymi Event Triggers

This trigger is executed when any of the selected Alkymi events occur.

Parameters

Name Key Required Type Description
display_name
display_name string

display name

Events
Events string

Returns

webhook event

WebhookEvent
WebHookEvent

Definitions

Dataset

dataset

Name Path Type Description
uuid
uuid uuid
name
name string
pipeline
pipeline string
documents
documents string
records
records string

Document

document

Name Path Type Description
uuid
uuid string

uuid

created
created string

created

modified
modified string

modified

status
status string

status

archived
archived boolean

archived

removed
removed boolean

removed

file_name
file_name string

file name

page_count
page_count integer

page count

pages
pages array of object

pages

number
pages.number integer

number

width
pages.width integer

width

height
pages.height integer

height

dataset
dataset string

dataset

records
records array of

records

pipeline_records
pipeline_records object

pipeline records

_s3_key
_s3_key string

s3 key

_replaced_by
_replaced_by string

replaced by

subject
subject string

subject

sender
sender string

sender

folder
folder string

folder

watermark_removed
watermark_removed boolean

watermark removed

Execution

execution

Name Path Type Description
uuid
uuid uuid
created
created date-time
reviewed
reviewed boolean
archived
archived boolean
status
status string
records
records array of string
pipeline_records
pipeline_records object
file_name
file_name string
documents
documents array of string

PaginatedDatasetList

dataset list

Name Path Type Description
count
count integer
next
next string
previous
previous string
results
results array of Dataset

PaginatedExecutionList

execution list

Name Path Type Description
count
count integer
next
next string
previous
previous string
results
results array of Execution

PaginatedPipelineConfigurationList

pipeline configuration list

Name Path Type Description
count
count integer
next
next string
previous
previous string
results
results array of PipelineConfiguration

PaginatedRecordList

record list

Name Path Type Description
count
count integer
next
next string
previous
previous string
results
results array of Record

PipelineConfiguration

pattern

Name Path Type Description
name
name string
records
records string
schemas
schemas array of Schema

Record

record

Name Path Type Description
uuid
uuid uuid
created
created date-time
modified
modified date-time
document_uuid
document_uuid string
document
document string
dataset
dataset string
pipeline
pipeline string
schema_name
schema_name string
status
status string
data
data object

Schema

schema

Name Path Type Description
name
name string
primary
primary boolean
fields
fields array of SchemaField

SchemaField

schema field

Name Path Type Description
name
name string
field_type
field_type string
sub_schema
sub_schema string

WebHookEvent

webhook event

Name Path Type Description
uuid
uuid string

uuid

status
status string

status

created
created string

created

records
records array of string

records

archived
archived boolean

archived

reviewed
reviewed boolean

reviewed

documents
documents array of string

documents

file_name
file_name string

file name

pipeline_records
pipeline_records object

pipeline records

trigger_event_list
trigger_event_list array of string

trigger event list

binary

This is the basic data type 'binary'.