Charthop

Charthop ai-hint API

The ai-hint API from Charthop — 3 operation(s) for ai-hint.

GitHub OpenAPI

Operations 6

GET /v1/ai-hint Find hints #
POST /v1/ai-hint Create a hint #
GET /v1/ai-hint/generate Generate placeholder hint content for a given tool and entity type #
GET /v1/ai-hint/{id} Get a hint #
PATCH /v1/ai-hint/{id} Update a hint #
DELETE /v1/ai-hint/{id} Delete a hint #

Documentation

📖
Documentation
https://docs.charthop.com/developer-basics

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/charthop/refs/heads/main/openapi/charthop-ai-hint-api-openapi.yml

Other Resources

🔗
Swagger
https://api.charthop.com/swagger

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/charthop-ai-hint-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

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

OpenAPI Specification

charthop-ai-hint-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: REST API for ChartHop
  version: V1.0.0
  title: ChartHop access AI Hint API
  contact:
    name: ChartHop
    url: https://www.charthop.com
    email: support@charthop.com
servers:
- url: https://localhost
- url: http://localhost
tags:
- name: ai-hint
paths:
  /v1/ai-hint:
    get:
      tags:
      - ai-hint
      summary: Find hints
      operationId: findHints
      parameters:
      - name: from
        in: query
        description: Identifier to paginate from
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsAiHint'
        '401':
          description: not authorized
        '403':
          description: permission denied
    post:
      tags:
      - ai-hint
      summary: Create a hint
      operationId: createHint
      responses:
        '201':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiHint'
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAiHint'
        description: Hint data to create
        required: true
  /v1/ai-hint/generate:
    get:
      tags:
      - ai-hint
      summary: Generate placeholder hint content for a given tool and entity type
      operationId: generateHint
      parameters:
      - name: toolName
        in: query
        description: Tool name
        required: false
        schema:
          type: string
      - name: entityType
        in: query
        description: Entity type
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
        '401':
          description: not authorized
        '403':
          description: permission denied
  /v1/ai-hint/{id}:
    get:
      tags:
      - ai-hint
      summary: Get a hint
      operationId: getHint
      parameters:
      - name: id
        in: path
        description: Hint identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiHint'
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: not found
    patch:
      tags:
      - ai-hint
      summary: Update a hint
      operationId: updateHint
      parameters:
      - name: id
        in: path
        description: Hint identifier
        required: true
        schema:
          type: string
      responses:
        '204':
          description: successful operation
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAiHint'
        description: Fields to update
        required: true
    delete:
      tags:
      - ai-hint
      summary: Delete a hint
      operationId: deleteHint
      parameters:
      - name: id
        in: path
        description: Hint identifier
        required: true
        schema:
          type: string
      responses:
        '204':
          description: successful operation
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: not found
components:
  schemas:
    Attribution:
      type: object
      properties:
        principalUserId:
          type: string
          example: 588f7ee98f138b19220041a7
        agentUserIds:
          type: array
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        eventId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiChatId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiToolUseId:
          type: string
        channel:
          type: string
          enum:
          - WEB
          - MOBILE
          - SLACK
          - TEAMS
          - MCP
    AiHint:
      type: object
      required:
      - id
      - name
      properties:
        id:
          type: string
          description: globally unique id
          example: 588f7ee98f138b19220041a7
        name:
          type: string
          description: unique name for this hint
        toolName:
          type: string
          description: tool name this hint applies to, e.g. Create, Update, Delete, DataExplorer
        entityType:
          type: string
          description: entity type this hint applies to, e.g. ACTION, FORM, REPORT
        keywords:
          type: array
          description: keywords that trigger this hint when matched in user messages
          items:
            type: string
        schema:
          type: string
          description: optional schema override; if null, auto-generated from the entity adapter's create class
        addHintIds:
          type: array
          description: additional hint ids to include when this hint is surfaced
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        content:
          type: string
          description: the hint content to provide to the AI
        createId:
          type: string
          description: created by user id
          example: 588f7ee98f138b19220041a7
        createBehalfId:
          type: string
          description: created on behalf of user id
          example: 588f7ee98f138b19220041a7
        createAttribution:
          $ref: '#/components/schemas/Attribution'
        createAt:
          type: string
          description: created timestamp
          example: '2017-01-24T13:57:52Z'
        updateId:
          type: string
          description: last updated by user id
          example: 588f7ee98f138b19220041a7
        updateBehalfId:
          type: string
          description: last updated on behalf of user id
          example: 588f7ee98f138b19220041a7
        updateAttribution:
          $ref: '#/components/schemas/Attribution'
        updateAt:
          type: string
          description: last updated timestamp
          example: '2017-01-24T13:57:52Z'
        deleteId:
          type: string
          description: deleted by user id
          example: 588f7ee98f138b19220041a7
        deleteBehalfId:
          type: string
          description: deleted on behalf of user id
          example: 588f7ee98f138b19220041a7
        deleteAttribution:
          $ref: '#/components/schemas/Attribution'
        deleteAt:
          type: string
          description: deleted timestamp
          example: '2017-01-24T13:57:52Z'
    CreateAiHint:
      type: object
      required:
      - name
      - content
      properties:
        name:
          type: string
          description: unique name for this hint
        toolName:
          type: string
          description: tool name this hint applies to, e.g. Create, Update, Delete, DataExplorer
        entityType:
          type: string
          description: entity type this hint applies to, e.g. ACTION, FORM, REPORT
        keywords:
          type: array
          description: keywords that trigger this hint when matched in user messages
          items:
            type: string
        schema:
          type: string
          description: optional schema override; if null, auto-generated from the entity adapter's create class
        addHintIds:
          type: array
          description: additional hint ids to include when this hint is surfaced
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        content:
          type: string
          description: the hint content to provide to the AI
    ResultsAccess:
      type: object
      required:
      - allowed
      properties:
        ids:
          type: array
          uniqueItems: true
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        allowed:
          type: array
          uniqueItems: true
          items:
            $ref: '#/components/schemas/AccessAction'
    AccessAction:
      type: object
      required:
      - action
      properties:
        action:
          type: string
        fields:
          type: array
          uniqueItems: true
          items:
            type: string
        types:
          type: array
          uniqueItems: true
          items:
            type: string
    UpdateAiHint:
      type: object
      properties:
        name:
          type: string
          description: unique name for this hint
        toolName:
          type: string
          description: tool name this hint applies to, e.g. Create, Update, Delete, DataExplorer
        entityType:
          type: string
          description: entity type this hint applies to, e.g. ACTION, FORM, REPORT
        keywords:
          type: array
          description: keywords that trigger this hint when matched in user messages
          items:
            type: string
        schema:
          type: string
          description: optional schema override; if null, auto-generated from the entity adapter's create class
        addHintIds:
          type: array
          description: additional hint ids to include when this hint is surfaced
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        content:
          type: string
          description: the hint content to provide to the AI
    ResultsAiHint:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AiHint'
        next:
          type: string
        access:
          type: array
          items:
            $ref: '#/components/schemas/ResultsAccess'