GuidesAPIStatusSign up

Quickstart

Make your first successful request in 2 min.

Create your workflow

Let's go directly in the app, you can create your first workflow starting from scratch or using one of our 80+ templates:

Once your workflow is ready with input and AI nodes configured, you can click on Live testing or Run workflow to test your workflow.


Test your workflow

You can now test your workflow by uploading input data and launching an execution:



Integrate the API

Launch Execution

Now that your workflow is working, you can copy the code snippet Launch execution that already contains:

  • Your API key
  • Your workflow ID

You just need to add your(s) input(s). Can be text, file, file url, number or boolean.

Once you have run this code, you will get in output a json containing the Execution ID:

{'id': 'be2ba5d1-7c45-4ce9-abae-7702b7ce3f61', 'content': {'status': 'running', 'results': {}, 'last_node_executed': 'RESPONDTOWEBHOOK'}, 'created_at': '2024-11-18T09:45:28.378364Z', 'updated_at': '2024-11-18T09:45:28.378376Z'}

Get Execution Result

You can now copy the second code snippet Get execution result and paste the Execution ID you got from the Launch exeucution in the endpoint URL:

url = "https://api.edenai.run/v2/workflow/c7fed277-0f8a-4be5-9831-a30789e9a1ba/execution/{execution_id}/"

You will get the result of your workflow execution. Here is an example:

{'content': {'last_node_executed': 'VERYLASTFIELD',
             'results': {'VERYLASTFIELD': {'errors': [],
                                           'results': [{...}, {...}, {}, {}]},
                         'ocr__identity_parser': {'errors': [],
                                                  'results': [{...},
                                                              {...},
                                                              {},
                                                              {}]},
                         'output': {'errors': [],
                                    'results': [{...}, {...}, {}, {}]}},
             'status': 'success'},
 'created_at': '2024-11-18T09:45:28.378364Z',
 'id': 'be2ba5d1-7c45-4ce9-abae-7702b7ce3f61',
 'updated_at': '2024-11-19T10:02:56.660990Z'}