AI suggestions API

4 operations. Authentication, errors and pagination work as described in the REST API overview.

Pending AI suggestions for your prompt

GET/api/v1/ai-suggestionsToken required

listAiSuggestions parameters
Name	Type	Description
`targetType` queryrequired	`"prompt"`
`targetId` queryrequired	`string`

Responses: 200 OK400, 401, 403, 404, 429

Response fields

listAiSuggestions response fields
Name	Type	Description
`items`required	`object[]`

Example

curl 'https://incantory.ai/api/v1/ai-suggestions' \
  -H "Authorization: Bearer $INCANTORY_TOKEN"

Ask for AI suggestions (tags, summary, variables, translation, duplicates)

POST/api/v1/ai-suggestionsToken required · scope write

Queued for the background worker; suggestions appear when it has run. Nothing changes until you apply one.

Request body

requestAiSuggestions body fields
Name	Type	Description
`targetType`required	`"prompt"`
`targetId`required	`string`
`kinds`	`("tags" \| "summary" \| "variables" \| "translation" \| "duplicate")[]`
`locale`	`"en" \| "zh"`	Target language for a translation request

Responses: 202 OK400, 401, 403, 404, 422, 429

Response fields

requestAiSuggestions response fields
Name	Type	Description
`queued`required	`boolean`

Example

curl -X POST 'https://incantory.ai/api/v1/ai-suggestions' \
  -H "Authorization: Bearer $INCANTORY_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"targetType":"prompt","targetId":"targetId"}'

Apply a suggestion

POST/api/v1/ai-suggestions/{id}/applyToken required · scope write

applyAiSuggestion parameters
Name	Type	Description
`id` pathrequired	`string`

Responses: 200 OK400, 401, 403, 404, 409, 422, 429

Response fields

applyAiSuggestion response fields
Name	Type	Description
`id`required	`string`
`status`required	`"applied"`
`kind`required	`string`

Example

curl -X POST 'https://incantory.ai/api/v1/ai-suggestions/{id}/apply' \
  -H "Authorization: Bearer $INCANTORY_TOKEN"

Dismiss a suggestion

POST/api/v1/ai-suggestions/{id}/dismissToken required · scope write

dismissAiSuggestion parameters
Name	Type	Description
`id` pathrequired	`string`

Responses: 200 OK400, 401, 403, 404, 409, 422, 429

Response fields

dismissAiSuggestion response fields
Name	Type	Description
`id`required	`string`
`status`required	`"dismissed"`

Example

curl -X POST 'https://incantory.ai/api/v1/ai-suggestions/{id}/dismiss' \
  -H "Authorization: Bearer $INCANTORY_TOKEN"