AiFailure

Type object

Shape

Field	Type	Description
coderequired	string
messagerequired	string	Safe developer-facing detail. Product UI renders localized copy by code.
retryablerequired	boolean
details	object

Example

{
  "code": "string",
  "message": "string",
  "retryable": false,
  "details": {}
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Used by

GET/v1/ai/providers/settings
Read non-secret AI provider settings
PUT/v1/ai/providers/selection
Select the active AI provider
PUT/v1/ai/providers/openai
Update non-secret OpenAI settings
PUT/v1/ai/providers/ollama
Update Ollama settings
POST/v1/ai/providers/{provider}/validate
Validate an AI provider and selected model
POST/v1/ai/providers/{provider}/models
List the models a local agent offers
POST/v1/ai/providers/{provider}/commands
List what a local agent can be told to do by name in a folder
POST/v1/ai/providers/ollama/pulls
Pull an Ollama model with bounded progress streaming
POST/v1/ai/providers/ollama/pulls/cancel
Cancel the active Ollama model pull
GET/v1/ai/chats
List AI chats
POST/v1/ai/chats
Create an AI chat
DELETE/v1/ai/chats
Clear all AI chat history
GET/v1/ai/chats/{chat}
Read an authoritative AI chat transcript
PATCH/v1/ai/chats/{chat}
Rename an AI chat
DELETE/v1/ai/chats/{chat}
Delete an AI chat while retaining anonymous usage
PATCH/v1/ai/chats/{chat}/pin
Pin or unpin an AI chat
PATCH/v1/ai/chats/{chat}/model
Change the model used by an AI chat
PATCH/v1/ai/chats/{chat}/privacy
Change whether agents and connected assistants can discover a chat
PATCH/v1/ai/chats/{chat}/folder
Choose the folder a chat's local agent works in
PATCH/v1/ai/chats/{chat}/agent-settings
Choose the approval mode a chat's local agent runs its next message in
POST/v1/ai/tools/chats/list
List non-private AI chats for a trusted tool caller
POST/v1/ai/tools/chats/search
Search non-private AI chats for a trusted tool caller
POST/v1/ai/tools/chats/read
Read a non-private AI chat for a trusted tool caller
GET/v1/ai/chats/{chat}/tool-policy
Read a chat's workspace-tool policy
PUT/v1/ai/chats/{chat}/tool-policy
Replace a chat's workspace-tool policy
POST/v1/ai/chats/{chat}/tool-policy/grants
Add workspace grants to a chat atomically
GET/v1/ai/usage
Read private local AI usage
DELETE/v1/ai/usage
Clear private local AI usage and feedback
GET/v1/ai/chats/{chat}/usage
Read current-chat and all private local AI usage
POST/v1/ai/search
Search finalized AI chat responses
PUT/v1/ai/messages/{message}/feedback
Append response feedback
POST/v1/ai/chats/{chat}/branches
Branch an AI chat
POST/v1/ai/chats/{chat}/retries
Retry a failed AI response
POST/v1/ai/chats/{chat}/exports
Store a chat prefix as a Koru document
GET/v1/ai/exports/{export}
Read an AI document export
POST/v1/ai/chats/{chat}/turns
Commit and stream an AI turn
GET/v1/ai/attempts/{attempt}
Read authoritative AI attempt state
POST/v1/ai/attempts/{attempt}/cancel
Cancel an AI attempt
POST/v1/ai/attempts/{attempt}/steer
Send a message into a running agent reply
POST/v1/ai/tool-calls/{tool}/approve
Approve a pending workspace-tool call
POST/v1/ai/tool-calls/{tool}/deny
Deny a pending workspace-tool call
GET/v1/ai/chats/{chat}/attachments/{attachment}
Read an attachment's stored original
PUT/v1/ai/chats/{chat}/attachments/{attachment}
Store a picture or file for a local agent chat's next message
DELETE/v1/ai/chats/{chat}/attachments/{attachment}
Remove a staged attachment
POST/v1/ai/chats/{chat}/attachments/reference
Stage a local file or folder path for a local agent chat
POST/v1/ai/chats/{chat}/attachments/from-workspace
Copy a granted workspace file into a local agent chat
POST/v1/ai/chats/{chat}/attachments/{attachment}/restage
Copy a sent attachment into a fresh staged attachment for recall
GET/v1/ai/chats/{chat}/attachments/{attachment}/thumbnail
Read a picture attachment's thumbnail

Generated from contract version 1. Last updated November 12, 2026.