Coactive

Coactive Queries API

The queries API from Coactive — 9 operation(s) for queries.

GitHub OpenAPI

Operations 11

POST /api/v1/queries/{query_id}/cancel Cancel Query #
POST /api/v1/queries Create Query #
GET /api/v1/queries List Queries #
DELETE /api/v1/queries/{query_id} Delete Query #
GET /api/v1/queries/{query_id} Get Query #
POST /api/v1/queries/{query_id}/exports Export Query #
GET /api/v1/queries/{query_id}/results Get Query Results Url #
GET /api/v1/datasets/{dataset_id}/tables/{table_name} Get Table #
GET /api/v1/datasets/{dataset_id}/tables List Tables #
POST /api/v1/queries/{query_id}/run Run Query #
POST /api/v1/queries/{query_id}/stop Stop Query #

Documentation

📖
Documentation
https://docs.coactive.ai/
📖
APIReference
https://docs.coactive.ai/api-reference/api-reference
📖
Authentication
https://artifacts.apis.io/coactive/authentication/coactive-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/coactive/openapi/coactive-queries-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-queries-app-api-v1-schema-get-query-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-queries-app-api-v1-schema-create-query-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-queries-app-api-v1-schema-list-queries-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-queries-export-query-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-queries-body-list-queries-api-v1-queries-get-schema.json
📊
JSONSchema
https://artifacts.apis.io/coactive/json-schema/coactive-queries-app-api-v1-schema-export-query-response-schema.json

Other Resources

🔗
ErrorCatalog
https://artifacts.apis.io/coactive/errors/coactive-error-codes.yml
🔗
Conventions
https://artifacts.apis.io/coactive/conventions/coactive-conventions.yml
🔗
DataModel
https://artifacts.apis.io/coactive/data-model/coactive-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/coactive:coactive-queries-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

coactive-queries-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference Queries API
  version: 1.0.0
servers:
- url: https://api.coactive.ai
  description: Production
- url: https://app.coactive.ai
  description: Production
tags:
- name: Queries
paths:
  /api/v1/queries/{query_id}/cancel:
    post:
      operationId: queries_cancel_query_api_v1_queries__query_id__cancel_post
      summary: Cancel Query
      tags:
      - Queries
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_app__api__v1__schema__GetQueryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/queries:
    post:
      operationId: queries_create_query_api_v1_queries_post
      summary: Create Query
      tags:
      - Queries
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_app__api__v1__schema__GetQueryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/queries_app__api__v1__schema__CreateQueryRequest'
      security:
      - HTTPBearer: []
    get:
      operationId: queries_list_queries_api_v1_queries_get
      summary: List Queries
      tags:
      - Queries
      parameters:
      - name: status
        in: query
        required: false
        schema:
          oneOf:
          - $ref: '#/components/schemas/queries_QueryStatus'
          - type: 'null'
      - name: dataset_id
        in: query
        required: false
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: exclude_no_code
        in: query
        required: false
        schema:
          type:
          - boolean
          - 'null'
      - name: exclude_code
        in: query
        required: false
        schema:
          type:
          - boolean
          - 'null'
      - name: query_types
        in: query
        required: false
        schema:
          oneOf:
          - $ref: '#/components/schemas/queries_QueryType'
          - type: 'null'
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_app__api__v1__schema__ListQueriesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/queries_Body_list_queries_api_v1_queries_get'
      security:
      - HTTPBearer: []
  /api/v1/queries/{query_id}:
    delete:
      operationId: queries_delete_query_api_v1_queries__query_id__delete
      summary: Delete Query
      tags:
      - Queries
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_app__api__v1__schema__GetQueryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_HTTPValidationError'
      security:
      - HTTPBearer: []
    get:
      operationId: queries_get_query_api_v1_queries__query_id__get
      summary: Get Query
      tags:
      - Queries
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_app__api__v1__schema__GetQueryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/queries/{query_id}/exports:
    post:
      operationId: queries_export_query_api_v1_queries__query_id__exports_post
      summary: Export Query
      tags:
      - Queries
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_app__api__v1__schema__ExportQueryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/queries_ExportQueryRequest'
      security:
      - HTTPBearer: []
  /api/v1/queries/{query_id}/results:
    get:
      operationId: queries_get_query_results_url_api_v1_queries__query_id__results_get
      summary: Get Query Results Url
      tags:
      - Queries
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: url_format
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/queries_ApiV1QueriesQueryIdResultsGetParametersUrlFormat'
      - name: expiration_seconds
        in: query
        required: false
        schema:
          type: integer
          default: 900
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_GetQueryResultsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/datasets/{dataset_id}/tables/{table_name}:
    get:
      operationId: queries_get_table_api_v1_datasets__dataset_id__tables__table_name__get
      summary: Get Table
      tags:
      - Queries
      parameters:
      - name: dataset_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: table_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_Table'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/datasets/{dataset_id}/tables:
    get:
      operationId: queries_list_tables_api_v1_datasets__dataset_id__tables_get
      summary: List Tables
      tags:
      - Queries
      parameters:
      - name: dataset_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_ListTablesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/queries/{query_id}/run:
    post:
      operationId: queries_run_query_api_v1_queries__query_id__run_post
      summary: Run Query
      tags:
      - Queries
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_app__api__v1__schema__GetQueryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/queries/{query_id}/stop:
    post:
      operationId: queries_stop_query_api_v1_queries__query_id__stop_post
      summary: Stop Query
      tags:
      - Queries
      parameters:
      - name: query_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_app__api__v1__schema__GetQueryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queries_HTTPValidationError'
      security:
      - HTTPBearer: []
components:
  schemas:
    queries_QueryStatus:
      type: string
      enum:
      - Queued
      - Running
      - Stopping
      - Stopped
      - Complete
      - Error
      description: All possible query status values
      title: QueryStatus
    queries_QueryType:
      type: string
      enum:
      - NATURAL_LANGUAGE
      - SQL
      description: All possible query types
      title: QueryType
    queries_ExportQueryRequest:
      type: object
      properties:
        connection_name:
          type:
          - string
          - 'null'
          default: coactive
        export_type:
          $ref: '#/components/schemas/queries_ExportType'
        target_bucket:
          type: string
        target_prefix:
          type: string
      required:
      - target_bucket
      - target_prefix
      title: ExportQueryRequest
    queries_HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/queries_ValidationError'
      title: HTTPValidationError
    queries_app__api__v1__schema__GetQueryResponse:
      type: object
      properties:
        query_id:
          type: string
          format: uuid
        query:
          type: string
        type:
          $ref: '#/components/schemas/queries_QueryType'
        status:
          $ref: '#/components/schemas/queries_QueryStatus'
        results:
          type:
          - string
          - 'null'
        start_dt:
          type:
          - string
          - 'null'
          format: date-time
        end_dt:
          type:
          - string
          - 'null'
          format: date-time
        dataset_id:
          type: string
          format: uuid
        total_row_count:
          type:
          - integer
          - 'null'
        parameters:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
        created_dt:
          type: string
          format: date-time
        updated_dt:
          type: string
          format: date-time
        created_user_id:
          type: string
        updated_user_id:
          type:
          - string
          - 'null'
      required:
      - query_id
      - query
      - type
      - status
      - results
      - dataset_id
      - created_dt
      - updated_dt
      - created_user_id
      title: app__api__v1__schema__GetQueryResponse
    queries_PagedLinksDetailsResponse:
      type: object
      properties:
        current:
          type: string
          description: The current page link
        previous:
          type:
          - string
          - 'null'
          description: The previous page, if applicable
        next:
          type:
          - string
          - 'null'
          description: The next page link, if applicable
      required:
      - current
      - previous
      - next
      description: Pagination metadata
      title: PagedLinksDetailsResponse
    queries_Table:
      type: object
      properties:
        name:
          type: string
        table_schema:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
      required:
      - name
      - table_schema
      title: Table
    queries_app__api__v1__schema__ExportQueryResponse:
      type: object
      properties:
        query_id:
          type: string
          format: uuid
        export_id:
          type: string
          format: uuid
        status:
          type: string
        message:
          type: string
      required:
      - query_id
      - export_id
      - status
      - message
      title: app__api__v1__schema__ExportQueryResponse
    queries_ExportType:
      type: string
      enum:
      - DELTA
      - CSV
      - UNITY
      description: All possible export types
      title: ExportType
    queries_app__api__v1__schema__ListQueriesResponse:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/queries_PagedMetaResponse'
          description: Metadata for the set of data returned
        data:
          type: array
          items:
            $ref: '#/components/schemas/queries_app__api__v1__schema__GetQueryResponse'
          description: The paginated data
      required:
      - meta
      - data
      title: app__api__v1__schema__ListQueriesResponse
    queries_ListTablesResponse:
      type: object
      properties:
        tables:
          type: array
          items:
            $ref: '#/components/schemas/queries_Table'
      required:
      - tables
      title: ListTablesResponse
    queries_GetQueryResultsResponse:
      type: object
      properties:
        query_id:
          type: string
          format: uuid
        download_url:
          type: string
      required:
      - query_id
      - download_url
      title: GetQueryResultsResponse
    queries_Body_list_queries_api_v1_queries_get:
      type: object
      properties:
        query_ids:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
        user_ids:
          type:
          - array
          - 'null'
          items:
            type: string
        exclude_user_ids:
          type:
          - array
          - 'null'
          items:
            type: string
      title: Body_list_queries_api_v1_queries_get
    queries_PagedMetaResponse:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/queries_PagedPageDetailsResponse'
          description: Details about the response page
        links:
          $ref: '#/components/schemas/queries_PagedLinksDetailsResponse'
          description: Links for easy page traversal
      required:
      - page
      - links
      description: Metadata about the paginated response
      title: PagedMetaResponse
    queries_ApiV1QueriesQueryIdResultsGetParametersUrlFormat:
      type: string
      enum:
      - download
      - direct
      default: download
      title: ApiV1QueriesQueryIdResultsGetParametersUrlFormat
    queries_ValidationError:
      type: object
      properties:
        loc:
          type: array
          items:
            $ref: '#/components/schemas/queries_ValidationErrorLocItems'
        msg:
          type: string
        type:
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
    queries_ValidationErrorLocItems:
      oneOf:
      - type: string
      - type: integer
      title: ValidationErrorLocItems
    queries_PagedPageDetailsResponse:
      type: object
      properties:
        current_page:
          type: integer
          description: Current page number
        limit:
          type: integer
          description: Number of items returned in the list response
        offset:
          type: integer
          description: Starting index returned for the list response
      required:
      - current_page
      - limit
      - offset
      description: Pagination metadata
      title: PagedPageDetailsResponse
    queries_app__api__v1__schema__CreateQueryRequest:
      type: object
      properties:
        dataset_id:
          type: string
          format: uuid
        query:
          type: string
        type:
          $ref: '#/components/schemas/queries_QueryType'
        parameters:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
        embedding_id:
          type:
          - string
          - 'null'
          format: uuid
        check_validity:
          type: boolean
          default: true
        dynamic_tags_version:
          type: string
          default: v2
      required:
      - dataset_id
      - query
      title: app__api__v1__schema__CreateQueryRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Coactive
  source: https://docs.coactive.ai/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)