Akkio Docs
  • Akkio Documentation
    • Akkio FAQ
  • Account and Settings
    • Team Settings
    • Organization Settings
    • Account Settings
    • Role Based Access Control
  • Demo Models
    • Demo Models
      • Lead Scoring
      • Retail Sales Forecasting
      • Predict Credit Card Fraud
      • Identify Customer Churn
  • Setting up Integrations
    • Connecting Data
    • Airtable (Beta)
    • Google Ads (Beta)
    • Google Analytics 4 (Beta)
    • Google BigQuery
    • Google BigQuery (Service Account)
    • Google Sheets
    • HubSpot (Beta)
    • MariaDB (Beta)
    • MongoDB (Beta)
    • MySQL (Beta)
    • PostgreSQL (Beta)
    • Redshift (Beta)
    • Salesforce
    • Akkio Data Chat for Slack
    • Snowflake (Username / Password) (Beta)
    • Zapier
  • Prepare your Data
    • Prepare
      • Chat Data Prep
      • Clean
      • Merge & Fuzzy Merge
      • Table View
      • Pivot View
      • Deploying Chat Data Prep
  • Explore
    • Chat Explore
    • Chart Types
  • Building a Model
    • Predict
      • Insights Report - Classification
      • Insights Report - Regression
    • Forecasting
      • Insights Report - Forecasting
    • Model Types
  • Deploying a Model
    • Deploy
      • Google BigQuery
      • Google Sheets
      • HubSpot (Beta)
      • PostgreSQL (Beta)
      • Salesforce
      • Snowflake (Beta)
      • Web App
      • Zapier
  • REPORTING AND SHARING
    • Reports
    • Dashboards
  • REST API
    • API Introduction
      • Quickstart
  • Concepts
    • Asynchronous Endpoints
    • Authentication
    • Code Generation
    • Terminology
  • Endpoints and Schemas
    • API Specifications
    • Endpoints
      • Chat Explore
      • Projects
      • Training
      • Models
      • Datasets
    • Schemas
    • Additional Libraries
      • Python Library
      • Node.js Library
Powered by GitBook
On this page

Was this helpful?

  1. Concepts

Asynchronous Endpoints

PreviousQuickstartNextAuthentication

Last updated 22 days ago

Was this helpful?

All long-running operations we offer through the API are exposed in an asynchronous manner. What this means is that these operations will generally require this query pattern on your part:

  • Initiate the task, usually at a /new endpoint, which gives you a task id

  • Query a nearby /status endpoint with that task ID to get the current status of the task. The statuses can be any of the following.

    • SUBMITTED: We have received your request but have not yet started working on it.

    • IN_PROGRESS: A worker is actively processing your request.

    • SUCCEEDED: Your request has been completed. A metadata field will be attached providing the location of the finished result, which you can generally issue a GET request to retrieve.

    • FAILED: Your request failed. A metadata field will be attached with a reason why, which can often be helpful in order to determine a fix and resubmit.

For a good example of an asynchronous endpoint, check out the .

Chat Explore endpoint page