---
title: "Get a hint"
method: GET
path: "/v1/ai-hint/{id}"
tags: ["ai-hint"]
---

# Get a hint

`GET /v1/ai-hint/{id}`

## Path parameters

- `id` string, required

## Response `200`

successful operation

- AiHint
  - `id` string, required — globally unique id
  - `name` string, required — unique name for this hint
  - `toolName` string — tool name this hint applies to, e.g. Create, Update, Delete, DataExplorer
  - `entityType` string — entity type this hint applies to, e.g. ACTION, FORM, REPORT
  - `keywords` string[] — keywords that trigger this hint when matched in user messages
  - `schema` string — optional schema override; if null, auto-generated from the entity adapter's create class
  - `addHintIds` string[] — additional hint ids to include when this hint is surfaced
  - `content` string — the hint content to provide to the AI
  - `createId` string — created by user id
  - `createBehalfId` string — created on behalf of user id
  - `createAttribution` Attribution
    - `principalUserId` string
    - `agentUserIds` string[]
    - `eventId` string
    - `aiChatId` string
    - `aiToolUseId` string
    - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
  - `createAt` string — created timestamp
  - `updateId` string — last updated by user id
  - `updateBehalfId` string — last updated on behalf of user id
  - `updateAttribution` Attribution
    - `principalUserId` string
    - `agentUserIds` string[]
    - `eventId` string
    - `aiChatId` string
    - `aiToolUseId` string
    - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
  - `updateAt` string — last updated timestamp
  - `deleteId` string — deleted by user id
  - `deleteBehalfId` string — deleted on behalf of user id
  - `deleteAttribution` Attribution
    - `principalUserId` string
    - `agentUserIds` string[]
    - `eventId` string
    - `aiChatId` string
    - `aiToolUseId` string
    - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
  - `deleteAt` string — deleted timestamp

## Other responses

- `401` — not authorized
- `403` — permission denied
- `404` — not found

---

[API](https://skmtc.net/charthop/apis/charthop-api.md) · [All operations](https://skmtc.net/charthop/apis/charthop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/charthop/charthop-api/revisions/50a1edd6b27e/schema)