{"openapi":"3.1.0","info":{"title":"Wedget AI Agent API","version":"2026-08-24","description":"Capability-scoped API for Grok and other tool-calling agents. Workspace identity is derived from the bearer key."},"servers":[{"url":"https://api.wedget.app/v1/chat/ai"}],"components":{"securitySchemes":{"aiAgentKey":{"type":"http","scheme":"bearer","bearerFormat":"wai_…"}}},"paths":{"/me":{"get":{"summary":"Inspect this AI connection","security":[{"aiAgentKey":[]}],"x-wedget-scope":"workspace:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/capabilities":{"get":{"summary":"List granted capabilities","security":[{"aiAgentKey":[]}],"x-wedget-scope":"workspace:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/conversations":{"get":{"summary":"List conversations","security":[{"aiAgentKey":[]}],"x-wedget-scope":"conversations:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/conversations/{id}":{"get":{"summary":"Get a conversation","security":[{"aiAgentKey":[]}],"x-wedget-scope":"conversations:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"patch":{"summary":"Manage a conversation","security":[{"aiAgentKey":[]}],"x-wedget-scope":"conversations:manage","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/conversations/{id}/messages":{"get":{"summary":"List messages","security":[{"aiAgentKey":[]}],"x-wedget-scope":"conversations:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"post":{"summary":"Reply to a conversation","security":[{"aiAgentKey":[]}],"x-wedget-scope":"conversations:reply","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/conversations/{id}/notes":{"post":{"summary":"Add an internal note","security":[{"aiAgentKey":[]}],"x-wedget-scope":"conversations:notes","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/visitors":{"get":{"summary":"List visitors","security":[{"aiAgentKey":[]}],"x-wedget-scope":"visitors:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/visitors/{id}":{"get":{"summary":"Get a visitor","security":[{"aiAgentKey":[]}],"x-wedget-scope":"visitors:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"patch":{"summary":"Moderate a visitor","security":[{"aiAgentKey":[]}],"x-wedget-scope":"visitors:moderate","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/visitors/{id}/records":{"get":{"summary":"List customer activity","security":[{"aiAgentKey":[]}],"x-wedget-scope":"customer-data:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/files":{"get":{"summary":"List files and pictures","security":[{"aiAgentKey":[]}],"x-wedget-scope":"files:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/files/{id}/content":{"get":{"summary":"Read an authenticated file","security":[{"aiAgentKey":[]}],"x-wedget-scope":"files:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/collections":{"get":{"summary":"List help collections","security":[{"aiAgentKey":[]}],"x-wedget-scope":"articles:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"post":{"summary":"Create a help collection","security":[{"aiAgentKey":[]}],"x-wedget-scope":"articles:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/collections/{id}":{"patch":{"summary":"Edit a help collection","security":[{"aiAgentKey":[]}],"x-wedget-scope":"articles:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"delete":{"summary":"Delete a help collection","security":[{"aiAgentKey":[]}],"x-wedget-scope":"articles:delete","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/articles":{"get":{"summary":"List help articles","security":[{"aiAgentKey":[]}],"x-wedget-scope":"articles:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"post":{"summary":"Create an article draft","security":[{"aiAgentKey":[]}],"x-wedget-scope":"articles:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/articles/{id}":{"get":{"summary":"Get an article","security":[{"aiAgentKey":[]}],"x-wedget-scope":"articles:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"patch":{"summary":"Edit an article draft","security":[{"aiAgentKey":[]}],"x-wedget-scope":"articles:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"delete":{"summary":"Delete an article","security":[{"aiAgentKey":[]}],"x-wedget-scope":"articles:delete","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/articles/{id}/publication":{"post":{"summary":"Publish or unpublish an article","security":[{"aiAgentKey":[]}],"x-wedget-scope":"articles:publish","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/widget":{"get":{"summary":"Read safe widget settings","security":[{"aiAgentKey":[]}],"x-wedget-scope":"widget:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"patch":{"summary":"Edit safe widget settings","security":[{"aiAgentKey":[]}],"x-wedget-scope":"widget:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/news":{"get":{"summary":"List news","security":[{"aiAgentKey":[]}],"x-wedget-scope":"news:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"post":{"summary":"Create a news draft","security":[{"aiAgentKey":[]}],"x-wedget-scope":"news:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/news/{id}":{"get":{"summary":"Get news","security":[{"aiAgentKey":[]}],"x-wedget-scope":"news:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"patch":{"summary":"Edit news","security":[{"aiAgentKey":[]}],"x-wedget-scope":"news:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"delete":{"summary":"Delete news","security":[{"aiAgentKey":[]}],"x-wedget-scope":"news:delete","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/news/{id}/publication":{"post":{"summary":"Publish or unpublish news","security":[{"aiAgentKey":[]}],"x-wedget-scope":"news:publish","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/automations":{"get":{"summary":"List automations","security":[{"aiAgentKey":[]}],"x-wedget-scope":"automations:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"post":{"summary":"Create an automation","security":[{"aiAgentKey":[]}],"x-wedget-scope":"automations:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/automations/{id}":{"patch":{"summary":"Edit an automation","security":[{"aiAgentKey":[]}],"x-wedget-scope":"automations:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"delete":{"summary":"Delete an automation","security":[{"aiAgentKey":[]}],"x-wedget-scope":"automations:delete","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/canned":{"get":{"summary":"List saved replies","security":[{"aiAgentKey":[]}],"x-wedget-scope":"canned:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"post":{"summary":"Create a saved reply","security":[{"aiAgentKey":[]}],"x-wedget-scope":"canned:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/canned/{id}":{"patch":{"summary":"Edit a saved reply","security":[{"aiAgentKey":[]}],"x-wedget-scope":"canned:write","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}},"delete":{"summary":"Delete a saved reply","security":[{"aiAgentKey":[]}],"x-wedget-scope":"canned:delete","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/analytics":{"get":{"summary":"Read support analytics","security":[{"aiAgentKey":[]}],"x-wedget-scope":"analytics:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}},"/team":{"get":{"summary":"List teammates","security":[{"aiAgentKey":[]}],"x-wedget-scope":"team:read","responses":{"200":{"description":"Success"},"4XX":{"description":"Error"}}}}}}