NOAN Technology Inc. API Tutorial Series

Welcome to the NOAN Technology Inc. API tutorial series. This guide is designed to help developers understand and utilize the NOAN platform API effectively. Whether you're looking to start a workflow, extract data, or integrate NOAN's AI capabilities into your application, this series will provide you with step-by-step instructions to achieve your goals.

Tutorial 1: Getting Started with NOAN API

Step 1: API Key and Authentication

• Objective: Learn how to obtain your API key and authenticate your requests.
• Instructions:
  1. Log in to your NOAN account dashboard.
  2. Navigate to the "API Access" section.
  3. Copy your unique API key.
  4. For authentication, include your API key in the header of your requests as Authorization: Bearer YOUR_API_KEY.

Step 2: Understanding the Base URL

• Objective: Familiarize yourself with the base URL for all API requests.
• Instructions:
  • The base URL for NOAN API requests is https://api.jsonify.com.
  • All endpoints described in this tutorial series will be appended to this base URL.

Tutorial 2: Starting a Workflow with a Webhook

Step 1: Identify Workflow and Node IDs

• Objective: Learn how to find the IDs necessary to start a workflow.
• Instructions:
  1. In the NOAN dashboard, navigate to the workflow you wish to start.
  2. Note the workflow_id and node_id displayed in the workflow's details.

Step 2: Making the API Call

• Objective: Execute an API call to start a workflow.
• Instructions:
  1. Construct your POST request to https://api.jsonify.com/api/v2/workflow/{workflow_id}/node/{node_id}/start.
  2. Replace {workflow_id} and {node_id} with the respective IDs from Step 1.
  3. Include any necessary input data as JSON in the request body.
  4. Send the request and monitor the response for success confirmation.

Tutorial 3: Retrieving the Latest Task Result

Step 1: Identifying the Workflow ID

• Objective: Learn how to locate the ID of the workflow whose results you want to retrieve.
• Instructions:
  1. Access the workflow section in the NOAN dashboard.
  2. Select the workflow of interest to view its details and workflow_id.

Step 2: Fetching the Latest Result

• Objective: Use the API to fetch the latest result of a specific workflow.
• Instructions:
  1. Send a GET request to https://api.jsonify.com/api/v2/workflow/{workflow_id}/latest.json.
  2. Replace {workflow_id} with the actual workflow ID.
  3. Review the JSON response containing the latest task result.

Tutorial 4: Extracting More Data from a Previous Result

Step 1: Identifying the Result ID

• Objective: Determine the ID of the result you wish to re-scan.
• Instructions:
  1. From your workflow's results page, identify the specific result's result_id.

Step 2: Re-scanning the Result

• Objective: Extract more data from an existing result.
• Instructions:
  1. Make a POST request to https://api.jsonify.com/api/v2/result/{result_id}/extract_data.
  2. Replace {result_id} with your target result ID.
  3. Optionally, include a new JSON schema or directive in the request body to guide the extraction.
  4. Analyze the response for the newly extracted data.

Tutorial 5: Advanced Data Extraction without a Workflow

Step 1: Preparing Your Request

• Objective: Learn to extract data from a URL ad-hoc, without setting up a workflow.
• Instructions:
  1. Determine the URL from which you want to extract data.
  2. Prepare any additional instructions or desired data schema.

Step 2: Executing the Extraction

• Objective: Perform an ad-hoc data extraction.
• Instructions:
  1. Send a POST request to https://api.jsonify.com/api/v2/extract/start.
  2. Include the target URL, any additional instructions, and the data schema in the request body.
  3. Review the response for your extracted data.

This tutorial series aims to equip developers with the knowledge to leverage NOAN's API for automating workflows, extracting valuable data, and integrating AI-driven insights into their applications. For further assistance or advanced use cases, please refer to our comprehensive API documentation or contact our developer support team.