> ## Documentation Index
> Fetch the complete documentation index at: https://hc.saas-manager.biz.nuro.jp/llms.txt
> Use this file to discover all available pages before exploring further.

# Exploring the AI Helpdesk API with AI

> The AI Helpdesk API is a read-only REST API. Pair it with AI coding assistants to streamline data exploration and operational workflows over sessions, knowledge articles, and procedures.

## AI Integration

The AI Helpdesk API is described in OpenAPI 3.1, a format AI coding assistants can read directly. Common use cases include:

* Natural-language data lookups ("show me unhandled sessions")
* Trend analysis and summary reports
* AI Agent workflows that reference knowledge articles and procedures

## Resources for AI Developers

### Using the OpenAPI Schema

The latest OpenAPI specification is available at:

```text theme={null}
https://assist.i.moneyforward.com/api/v1/openapi.json
```

Feed this schema to AI coding tools (Claude Code, Cursor, Devin, …) so they understand the endpoints and parameters before generating client code.

### Building a Natural-Language Interface

Because the API is read-only, it is particularly well-suited for lookup interfaces driven by AI.

Examples:

* "List 10 unhandled sessions"
* "Group sessions closed in the last 7 days by assignee type"
* "Show all knowledge articles in the `onboarding` category"

### Code Generation

Use AI to generate API request code from natural-language instructions:

1. Describe what you want in plain language
2. The AI picks the right endpoint (e.g. `/api/v1/sessions`, `/api/v1/knowledge`)
3. Get runnable code with the `X-API-Key` header set

## Best Practices

### Security

* Never hand the AI tool your API key in plain text — load it from an environment variable
* Review AI-generated code for security issues before running it
* Avoid issuing over-privileged keys (only grant ADMIN role when needed)

### Error Handling

* Have AI-generated code branch on `{"ok": false, "error": ...}` rather than HTTP status alone
* Keep request rate below `~20 RPS` per key to avoid upstream throttling

### Data Privacy

* Mask session content and personally identifiable information before feeding it to the AI
* Review the AI tool's data retention policy before sending sensitive content

## Sample Use Cases

### Daily Report Generation

```python theme={null}
# Prompt: "Summarize open and in-progress sessions by assignee type"
# 1. GET /api/v1/sessions/stats — counts by status
# 2. GET /api/v1/sessions?status=open — the list
# 3. AI writes a narrative summary
```

### Knowledge Coverage Analysis

```python theme={null}
# Prompt: "Suggest knowledge articles that should exist based on unresolved sessions"
# 1. GET /api/v1/sessions?status=open
# 2. GET /api/v1/knowledge
# 3. AI identifies the gap
```

## Support

If you have questions about AI integration, please contact the support team.