Skip to content

Hi Coactive team!

This is a sample of what your docs might look like on Starport, based on your public docs.

Take a look! Ask AI, search, the MCP server, and Markdown copies all work.

Starport is a free and open-source docs framework based on Starlight and maintained by Promptless. Promptless is the AI agent that automatically updates your customer-facing docs.

Every annual Promptless plan comes with white-glove migration to Starport, where we migrate the content, tune the result with you, and you own the repository so you're never locked in.

Book a 15-minute walkthrough

Sample migration of Coactive docs to Starport, prepared by PromptlessBook 15-minute call

Coactive AI | DocsCoactive AI | Docs

Programmatically Retrieve SQL results

This tutorial focuses on programmatically retrieving SQL query results to extract metadata using the Coactive API and Coactive SQL Engine functionality.

Step 1: Setting Up Authorization

Section titled “Step 1: Setting Up Authorization”

Retrieve and setup API Credentials

Section titled “Retrieve and setup API Credentials”
  1. Refer to our API Authenication page

Step 2: Submitting a Query

Section titled “Step 2: Submitting a Query”

To automate queries, use the Coactive API’s asynchronous query submission functionality.

Example Query Submission

Section titled “Example Query Submission”

Use the following curl command to submit a SQL query:

Curl

Terminal window
curl -X POST https://api.coactive.ai/api/v1/queries \
        -H "Authorization: Bearer <CLIENT_ID>:<CLIENT_SECRET>" \
        -H "Content-Type: application/json" \
        -d '{"query": "SELECT * FROM coactive_table", \
              "dataset_id": "<DATASET_ID>" \
            }'

API Response

Section titled “API Response”

The API responds with query details including the query_id:

API_Response

Terminal window
{    "query_id": "<QUERY_ID>",
        "status": "Queued",
        "dataset_id": "<DATASET_ID>"  }

Step 3: Checking Query Status

Section titled “Step 3: Checking Query Status”

To check the status of your query, use the query_id returned in the previous response:

Curl

Terminal window
curl https://api.coactive.ai/api/v1/queries/<QUERY_ID> \
      -H "Authorization: Bearer <CLIENT_ID>:<CLIENT_SECRET>"

Example Status Response

Section titled “Example Status Response”

wordwrap

Terminal window
{"query_id": "<QUERY_ID>",
  "status": "Complete",
  "dataset_id": "<DATASET_ID>",
  "total_row_count": 100  }

Step 4: Downloading Results

Section titled “Step 4: Downloading Results”

Once the query status is “Complete,” retrieve the results download URL:

Curl

Terminal window
curl https://api.coactive.ai/api/v1/queries/<QUERY_ID>/results \
      -H "Authorization: Bearer <CLIENT_ID>:<CLIENT_SECRET>"

Example Response

Section titled “Example Response”

The response provides a temporary link to download the results:

API Response

Terminal window
{    "query_id": "<QUERY_ID>",
     "download_url": "https://api.coactive.ai/presigned/...."  }

Notes

Section titled “Notes”
  • The download link expires 15 minutes after it is generated (configurable via the expiration_seconds query parameter).

Example: Full Query Execution Workflow

Section titled “Example: Full Query Execution Workflow”

  1. Submit a query via POST.

  2. Use the query_id to check the status of the query.

  3. Once the status is “Complete,” download the results.

Section titled “Key Links”
↑↓ Select↵ Open