Akkio Chat Explore API
The Chat Explore API from Akkio — 28 operation(s) for chat explore.
The Chat Explore API from Akkio — 28 operation(s) for chat explore.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/akkio-chat-explore-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Akkio Chat Explore API
version: 0.1.0
description: 'Operations tagged Chat Explore across 2 of this provider''s published API definitions: akkio-platform-api-openapi.json, akkio-public-api-openapi.yaml. Each path carries the servers of the definition it was published in.'
tags:
- name: Chat Explore
paths:
/api/v1/chat-explore/status/{task_id}:
get:
tags:
- Chat Explore
summary: ' Get Chat Explore Status'
description: Retrieves the status of the provided Chat Explore task id.
operationId: _get_chat_explore_status_api_v1_chat_explore_status__task_id__get
parameters:
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/APIStatusResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/chat-explore/chats/{id}:
get:
tags:
- Chat Explore
summary: ' Get Chat'
description: Retrieves a chat by id.
operationId: _get_chat_api_v1_chat_explore_chats__id__get
parameters:
- name: id
in: path
required: true
schema:
type: string
title: Id
- name: image_format
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/ChatExploreImageFormat'
- type: 'null'
title: Image Format
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/_ApiBaseChatRecord'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/chat-explore/new:
post:
tags:
- Chat Explore
summary: ' Submit Chat Explore Query'
description: Query Chat Explore through API. Takes in a list of messages and gives you the message Chat Explore sent back.
operationId: _submit_chat_explore_query_api_v1_chat_explore_new_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChatExploreRequestPayload'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/APITaskStartedResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/chat-explore:
post:
summary: Chat Explore Route
operationId: chat_explore_route_chat_explore_post
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
tags:
- Chat Explore
/multi_table/chat-explore:
post:
tags:
- Chat Explore
summary: ' Controller Chat Explore'
operationId: _controller_chat_explore_multi_table_chat_explore_post
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/multi_table/chat-explore-suggestions:
post:
tags:
- Chat Explore
summary: Chat Explore Suggestions Route Async
description: Generate suggestions
operationId: chat_explore_suggestions_route_async_multi_table_chat_explore_suggestions_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MultiTableChatExploreSuggestionsRequestPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MultiTableChatExploreSuggestionsResponsePayload'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/multi_table_chat_explore/chat-explore:
post:
tags:
- Chat Explore
summary: ' Controller Chat Explore'
operationId: _controller_chat_explore_multi_table_chat_explore_chat_explore_post
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/multi_table_chat_explore/chat-explore-suggestions:
post:
tags:
- Chat Explore
summary: Chat Explore Suggestions Route Async
operationId: chat_explore_suggestions_route_async_multi_table_chat_explore_chat_explore_suggestions_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MultiTableChatExploreSuggestionsRequestPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MultiTableChatExploreSuggestionsResponsePayload'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/measurement/build-chart:
post:
tags:
- Chat Explore
summary: Build Chart
operationId: build_chart_measurement_build_chart_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BuildChartPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/src__async_job__service__build_concrete_async_job_record_class___locals___ConcreteAsyncJobRecord__2'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/measurement/chart_summary:
post:
tags:
- Chat Explore
summary: Chart Summary
operationId: chart_summary_measurement_chart_summary_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementChartSummaryPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementChartSummaryResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/measurement/dashboard_summary:
post:
tags:
- Chat Explore
summary: Dashboard Summary
operationId: dashboard_summary_measurement_dashboard_summary_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementDashboardSummaryPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementDashboardSummaryResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/measurement/dashboard_banner_image:
post:
tags:
- Chat Explore
summary: ' Get Banner Image'
operationId: _get_banner_image_measurement_dashboard_banner_image_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementDashboardBannerPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementDashboardBannerResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/measurement/chat-explore:
post:
tags:
- Chat Explore
summary: ' Controller Chat Explore'
operationId: _controller_chat_explore_measurement_chat_explore_post
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/measurement/chart/refresh:
post:
tags:
- Chat Explore
summary: ' Controller Chart Refresh'
operationId: _controller_chart_refresh_measurement_chart_refresh_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementChartRefreshPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChartRefreshResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/ad_analytics/measurement/build-chart:
post:
tags:
- Chat Explore
summary: Build Chart
operationId: build_chart_ad_analytics_measurement_build_chart_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BuildChartPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/src__async_job__service__build_concrete_async_job_record_class___locals___ConcreteAsyncJobRecord__2'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/ad_analytics/measurement/chart_summary:
post:
tags:
- Chat Explore
summary: Chart Summary
operationId: chart_summary_ad_analytics_measurement_chart_summary_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementChartSummaryPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementChartSummaryResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/ad_analytics/measurement/dashboard_summary:
post:
tags:
- Chat Explore
summary: Dashboard Summary
operationId: dashboard_summary_ad_analytics_measurement_dashboard_summary_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementDashboardSummaryPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementDashboardSummaryResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/ad_analytics/measurement/dashboard_banner_image:
post:
tags:
- Chat Explore
summary: ' Get Banner Image'
operationId: _get_banner_image_ad_analytics_measurement_dashboard_banner_image_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementDashboardBannerPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementDashboardBannerResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/proof-of-concept/rco/chat-explore-suggestions:
post:
tags:
- Chat Explore
summary: Chat Explore Suggestions Route Async
description: Generate suggestions
operationId: chat_explore_suggestions_route_async_proof_of_concept_rco_chat_explore_suggestions_post
requestBody:
content:
application/json:
schema:
type: object
title: Payload
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
type: string
type: array
title: Response Chat Explore Suggestions Route Async Proof Of Concept Rco Chat Explore Suggestions Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/proof-of-concept/rco/chat-explore:
post:
tags:
- Chat Explore
summary: ' Controller Chat Explore'
operationId: _controller_chat_explore_proof_of_concept_rco_chat_explore_post
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/proof-of-concept/rco/available_reach_curve_units:
post:
tags:
- Chat Explore
summary: ' Get Available Reach Curve Units'
operationId: _get_available_reach_curve_units_proof_of_concept_rco_available_reach_curve_units_post
parameters:
- name: target_audience
in: query
required: true
schema:
type: string
title: Target Audience
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResponseUnits'
title: Response Get Available Reach Curve Units Proof Of Concept Rco Available Reach Curve Units Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/proof-of-concept/rco/reach_curves:
post:
tags:
- Chat Explore
summary: ' Get Reach Curve For Media Plan Scope'
operationId: _get_reach_curve_for_media_plan_scope_proof_of_concept_rco_reach_curves_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MediaPlanScope'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties:
$ref: '#/components/schemas/ReachCurve-Output'
type: object
title: Response Get Reach Curve For Media Plan Scope Proof Of Concept Rco Reach Curves Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/proof-of-concept/rco/optimize:
post:
tags:
- Chat Explore
summary: ' Get Reach Curve Optimization'
operationId: _get_reach_curve_optimization_proof_of_concept_rco_optimize_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OptimizePayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- type: integer
- $ref: '#/components/schemas/OptimizeErrorPayload'
title: Response Get Reach Curve Optimization Proof Of Concept Rco Optimize Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/proof-of-concept/rco/optimized-over-budget:
post:
tags:
- Chat Explore
summary: ' Get Reach Curve Optimization Over Budget'
operationId: _get_reach_curve_optimization_over_budget_proof_of_concept_rco_optimized_over_budget_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OptimizedOverBudgetPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
type: integer
type: array
title: Response Get Reach Curve Optimization Over Budget Proof Of Concept Rco Optimized Over Budget Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/proof-of-concept/rco/targets:
get:
tags:
- Chat Explore
summary: ' Get Reach Curve Targets'
operationId: _get_reach_curve_targets_proof_of_concept_rco_targets_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
additionalProperties:
anyOf:
- type: string
- type: integer
type: object
type: array
title: Response Get Reach Curve Targets Proof Of Concept Rco Targets Get
/proof-of-concept/rco/edit-reach-curve:
post:
tags:
- Chat Explore
summary: ' Post Edit Reach Curve'
operationId: _post_edit_reach_curve_proof_of_concept_rco_edit_reach_curve_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EditReachCurvePayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ReachCurve-Output'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/proof-of-concept/rco/upload-from-s3:
get:
tags:
- Chat Explore
summary: ' Upload From S3'
operationId: _upload_from_s3_proof_of_concept_rco_upload_from_s3_get
parameters:
- name: s3_path
in: query
required: true
schema:
type: string
title: S3 Path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
type: object
additionalProperties:
anyOf:
- type: string
- type: array
items:
type: string
title: Response Upload From S3 Proof Of Concept Rco Upload From S3 Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/proof-of-concept/rco/banner-image:
post:
tags:
- Chat Explore
summary: ' Get Banner Image'
operationId: _get_banner_image_proof_of_concept_rco_banner_image_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MediaPlanScope'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Get Banner Image Proof Of Concept Rco Banner Image Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
APIStatusMetadataSucceeded:
properties:
type:
type: string
enum:
- SUCCEEDED
const: SUCCEEDED
title: Type
default: SUCCEEDED
location:
type: string
title: Location
description: The path at which you can submit a GET request to retrieve the result of the successful job. May require proper authentication or authorization to access.
additionalProperties: true
type: object
required:
- location
title: APIStatusMetadataSucceeded
APIStatusMetadataFailed:
properties:
type:
type: string
enum:
- FAILED
const: FAILED
title: Type
default: FAILED
error:
type: string
title: Error
description: If provided, a text representation of what went wrong with the task, including if any action on your part may rectify the issue.
default: Unable to complete request. Please verify your inputs, try again later, or get in touch at support@akkio.com.
additionalProperties: true
type: object
title: APIStatusMetadataFailed
APIStatusResponse:
properties:
status:
$ref: '#/components/schemas/TaskStatusEnum'
description: The current status of the task being queried.
metadata:
oneOf:
- $ref: '#/components/schemas/APIStatusMetadataPending'
- $ref: '#/components/schemas/APIStatusMetadataInProgress'
- $ref: '#/components/schemas/APIStatusMetadataSucceeded'
- $ref: '#/components/schemas/APIStatusMetadataFailed'
title: Metadata
description: Metadata, contextually dependent on the status of the task being queried.
discriminator:
propertyName: type
mapping:
FAILED: '#/components/schemas/APIStatusMetadataFailed'
IN_PROGRESS: '#/components/schemas/APIStatusMetadataInProgress'
PENDING: '#/components/schemas/APIStatusMetadataPending'
SUCCEEDED: '#/components/schemas/APIStatusMetadataSucceeded'
additionalProperties: true
type: object
required:
- status
- metadata
title: APIStatusResponse
TaskStatusEnum:
type: string
enum:
- PENDING
- IN_PROGRESS
- SUCCEEDED
- FAILED
- UNKNOWN_TIMEOUT
title: TaskStatusEnum
description: Celery task status enum. Update apps/web-backend-api/src/types/TaskStatusEnum.ts if you update this enum.
APITaskStartedResponse:
properties:
task_id:
type: string
title: Task Id
description: The ID of the task that was started. This is generally queryable at a nearby `/status` endpoint to get the current status of the task.
additionalProperties: true
type: object
required:
- task_id
title: APITaskStartedResponse
ChatExploreRequestPayload:
properties:
project_id:
anyOf:
- type: string
- type: 'null'
title: Project Id
description: The project ID which you want to run a Chat Explore query against. Either this or dataset_id must be specified; if this is specified, custom instructions attached to the project will be provided as context to the query.
dataset_id:
anyOf:
- type: string
- type: 'null'
title: Dataset Id
description: The dataset ID which you want to run a Chat Explore query against. Either this or project_id must be specified.
messages:
items:
$ref: '#/components/schemas/APIChatMessage'
type: array
title: Messages
description: A list of messages to query Chat Explore with.
chatContext:
type: string
title: Chatcontext
description: 'Anything you''d like Chat Explore to know about this application to provide better responses. For example: (1) This dataset is customer engagement data, (2) The units of the sales column are in millions, (3) The data is messy and contains typos'
default: ''
chatInstructions:
type: string
title: Chatinstructions
default: ''
additionalProperties: true
type: object
required:
- messages
title: ChatExploreRequestPayload
_ApiBaseChatRecord:
properties:
_owner:
type: string
title: ' Owner'
description: Foreign key to the user this object belongs to.
_org:
type: string
title: ' Org'
description: Foreign key to the organization this object belongs to.
messages:
items:
$ref: '#/components/schemas/APIChatMessage'
type: array
title: Messages
description: List of messages in the chat.
additionalProperties: true
type: object
required:
- _owner
- _org
- messages
title: _ApiBaseChatRecord
APIStatusMetadataPending:
properties:
type:
type: string
enum:
- PENDING
const: PENDING
title: Type
default: PENDING
additionalProperties: true
type: object
title: APIStatusMetadataPending
APIChatMessage:
properties:
role:
$ref: '#/components/schemas/RolesEnum'
description: The role of this message. User indicates the user sent the message, assistant indicates the assistant sent the message.
content:
type: string
title: Content
description: The text content of this message.
images:
items:
anyOf:
- type: string
- type: object
type: array
title: Images
description: List of images for this message (potentially of length zero). May be exposed either as a base64 string or as stringified Plotly JSON, typically if the user requested it as such.
default: []
table:
anyOf:
- items:
type: object
type: array
- type: 'null'
title: Table
description: If there exists a table for this message, this will be set to a list of objects/records, where each record has a key of the column name and a value for that row's corresponding value for the column.
additionalProperties: true
type: object
required:
- role
- content
title: APIChatMessage
RolesEnum:
type: string
enum:
- user
- assistant
title: RolesEnum
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
APIStatusMetadataInProgress:
properties:
type:
type: string
enum:
- IN_PROGRESS
const: IN_PROGRESS
title: Type
default: IN_PROGRESS
estimate_seconds:
anyOf:
- type: number
- type: 'null'
title: Estimate Seconds
description: If provided, an estimate of how many seconds we expect this task to take. This value should be treated as a rough estimate on a best-effort basis, not a guarantee.
additionalProperties: true
type: object
title: APIStatusMetadataInProgress
ChatExploreImageFormat:
type: string
enum:
- base64_png
- plotly_json
title: ChatExploreImageFormat
MeasurementFilters:
properties:
timeframe:
anyOf:
- $ref: '#/components/schemas/MeasurementTimeframe'
- type: 'null'
description: Timeframe of the filter
comparison_timeframe:
anyOf:
- $ref: '#/components/schemas/MeasurementTimeframe'
- type: 'null'
description: Timeframe for comparison data
drilldown:
anyOf:
- $ref: '#/components/schemas/DrilldownConfig'
- type: 'null'
description: Drill-down configuration
raw_measurement_filter:
type: object
title: Raw Measurement Filter
additionalProperties: true
type: object
title: MeasurementFilters
description: Measurement filter with dynamic field support for hierarchy-based filtering
MeasurementChartSummaryPayload:
properties:
filters:
$ref: '#/components/schemas/MeasurementFilters'
chart_metadata_id:
type: integer
title: Chart Metadata Id
chart_data_id:
type: integer
title: Chart Data Id
additionalProperties: true
type: object
required:
- filters
- chart_metadata_id
- chart_data_id
title: MeasurementChartSummaryPayload
MeasurementDashboardSummaryPayload:
properties:
filters:
$ref: '#/components/schemas/MeasurementFilters'
charts:
items:
$ref: '#/components/schemas/MeasurementDashboardChartPayload'
type: array
title: Charts
title:
anyOf:
- type: string
- type: 'null'
title: Title
additionalProperties: true
type: object
required:
- filters
- charts
title: MeasurementDashboardSummaryPayload
CurveUnits:
properties:
allocation:
$ref: '#/components/schemas/AllocationUnits'
description: Units of the allocation
response:
$ref: '#/components/schemas/ResponseUnits'
description: Units of the response
additionalProperties: true
type: object
required:
- allocation
- response
title: CurveUnits
MeasurementDashboardBannerResult:
properties:
presigned_url:
type: string
title: Presigned Url
storage_path:
type: string
title: Storage Path
additionalProperties: true
type: object
required:
- presigned_url
- storage_path
title: MeasurementDashboardBannerResult
DrilldownTableRow:
properties:
id:
type: string
title: Id
description: Unique identifier for the row
columns:
add
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akkio/refs/heads/main/openapi/akkio-chat-explore-api-openapi.yml