> ## Documentation Index > Fetch the complete documentation index at: https://octolens.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Convert natural language to filters > Uses an LLM to convert a natural-language query (e.g. "posts from twitter influencers about pricing this week") into a structured filter object usable with /api/v2/mentions. ## OpenAPI ````yaml https://app.octolens.com/api/v2/openapi.json post /api/v2/ai/filter-wizard openapi: 3.1.0 info: title: Octolens API version: 2.0.0 description: >- The Octolens API lets you query mentions, manage keywords, and configure feeds programmatically. Every action available in the Octolens UI is available here. ### Authentication All v2 endpoints require an API key. Create one in **Settings > API** and pass it as `Authorization: Bearer `. Keys are scoped to the organization they were minted in; you cannot access another org's data. API keys carry a scope — `read`, `write` (implies read), or `admin` (implies write). Each endpoint documents the scope it needs via the `x-required-scope` OpenAPI extension and the scope badge in the docs surface. ### Rate limiting The v2 API is rate-limited at **500 requests per hour per organization**, across all keys for that org. The limit resets at the top of each hour (sliding hourly window). Every 2xx response carries three headers so clients can pace themselves: * `X-RateLimit-Limit` — the hourly cap (500) * `X-RateLimit-Remaining` — requests left in the current window * `X-RateLimit-Reset` — Unix timestamp (seconds) when the window resets When the cap is hit, the endpoint returns **429 Rate Limited** with an additional `Retry-After` header (seconds until the next window). The response body is the standard `ErrorResponse` with `code: "RATE_LIMITED"`. ### Error handling All non-2xx responses share the same `ErrorResponse` envelope: `{ error: { code, message, status, details? } }`. The `code` field is a stable `ApiErrorCode` enum — branch on it programmatically instead of parsing `message`. See the `ApiErrorCode` schema for the full catalog grouped by category. `VALIDATION_ERROR` (400) responses include a `details` array with per-field Zod issues — inspect `details[i].path` to pinpoint which input was rejected. ### Building filter bodies Endpoints that accept `simpleFilters` / `advancedFilters` (e.g. `POST /api/v2/mentions`, `PATCH /api/v2/feeds/{id}`) take a structured object that can be tricky to hand-craft. If you just have a natural-language description of what you want ("negative posts about pricing on reddit in the last week"), call `POST /api/v2/ai/filter-wizard` with that prompt and it will return a ready-to-use filter object you can pass straight through. servers: - url: https://app.octolens.com description: Production - url: http://localhost:3000 description: Local development security: - ApiKey: [] paths: /api/v2/ai/filter-wizard: post: tags: - AI summary: Convert natural language to filters description: >- Uses an LLM to convert a natural-language query (e.g. "posts from twitter influencers about pricing this week") into a structured filter object usable with /api/v2/mentions. operationId: generateFilter requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateFilterRequest' responses: '200': description: 200 response content: application/json: schema: $ref: '#/components/schemas/GenerateFilterResponse' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Missing or invalid authentication content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden (insufficient plan or permissions) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: GenerateFilterRequest: description: Convert a natural-language query into an Octolens filter object. type: object properties: query: description: Natural-language description of what the user wants to see. example: only negative tweets about pricing from the last 7 days type: string minLength: 1 maxLength: 1000 required: - query GenerateFilterResponse: description: >- Filter object generated from a natural-language query. Client applies `filters` to the feed and shows `explanation` to the user. type: object properties: filters: description: >- Generated filter object. `null` when the query is ambiguous. Use `isAdvanced` to determine whether it's the simple or advanced shape. anyOf: - anyOf: - $ref: '#/components/schemas/SimpleFiltersOutput' - $ref: '#/components/schemas/AdvancedFiltersOutput' - type: 'null' isAdvanced: description: >- If `true`, `filters` is an `AdvancedFilters` shape (AND/OR groups). Otherwise it's a `SimpleFilters` (flat AND list). type: boolean limit: description: >- Requested page size — preserved from `currentLimit` unless the user asked to change it. type: integer minimum: -9007199254740991 maximum: 9007199254740991 includeAll: description: Whether to include low-relevance posts. type: boolean view: description: >- View id the AI resolved the query against (if the user referenced a view by name). `null` otherwise. anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' explanation: description: >- Plain-English summary of what the filter will match — shown in the UI. type: string required: - filters - isAdvanced - limit - includeAll - view - explanation additionalProperties: false ErrorResponse: description: >- Standard error envelope returned for all non-2xx responses. The `code` field is stable — safe to branch on programmatically. type: object properties: error: type: object properties: code: $ref: '#/components/schemas/ApiErrorCode' description: >- Machine-readable error code. See `ApiErrorCode` for the full list. example: NOT_FOUND message: description: Human-readable error message. example: Resource not found type: string status: description: HTTP status code — always matches the response status. example: 404 type: integer minimum: -9007199254740991 maximum: 9007199254740991 details: description: >- Present on `VALIDATION_ERROR` responses. Contains Zod issues describing each failing field (path, code, message). type: array items: {} required: - code - message - status additionalProperties: false required: - error additionalProperties: false SimpleFiltersOutput: description: Simple AND-combined filter list. type: object properties: conditions: description: Flat list of conditions. Implicitly combined with AND. type: array items: $ref: '#/components/schemas/SimpleFilterConditionOutput' required: - conditions additionalProperties: false AdvancedFiltersOutput: description: Nested filter expression — groups of conditions combined with AND/OR. type: object properties: top_level_operator: description: How the groups combine at the top level. type: string enum: - AND - OR groups: description: One or more filter groups. type: array items: $ref: '#/components/schemas/AdvancedFilterGroupOutput' required: - top_level_operator - groups additionalProperties: false ApiErrorCode: description: >- Stable, machine-readable error code. Grouped as follows: **Auth / request shape** — `UNAUTHORIZED` (401), `FORBIDDEN` (403), `RATE_LIMITED` (429), `VALIDATION_ERROR` (400 — response carries a `details` array with Zod issues), `INTERNAL_ERROR` (500). **Not found (404)** — generic `NOT_FOUND` plus domain-specific variants: `FEED_NOT_FOUND`, `KEYWORD_NOT_FOUND`, `POST_NOT_FOUND`, `SUMMARY_NOT_FOUND`, `SUGGESTION_NOT_FOUND`, `COMPANY_NOT_FOUND`, `ORG_NOT_FOUND`, `SETTINGS_NOT_FOUND`. **Business-rule violations (400)** — `KEYWORD_LIMIT_EXCEEDED` (plan cap hit), `LAST_ADMIN` (refuses to remove the only admin), `ITEM_EXISTS` (duplicate), `INVALID_DOMAIN`, `INVALID_TIMEZONE`. type: string enum: - UNAUTHORIZED - FORBIDDEN - RATE_LIMITED - VALIDATION_ERROR - INTERNAL_ERROR - NOT_FOUND - FEED_NOT_FOUND - KEYWORD_NOT_FOUND - POST_NOT_FOUND - SUMMARY_NOT_FOUND - SUGGESTION_NOT_FOUND - COMPANY_NOT_FOUND - ORG_NOT_FOUND - SETTINGS_NOT_FOUND - KEYWORD_LIMIT_EXCEEDED - LAST_ADMIN - ITEM_EXISTS - INVALID_DOMAIN - INVALID_TIMEZONE SimpleFilterConditionOutput: type: object properties: field: description: >- Field name to filter on. Common values: `Keywords`, `Source`, `Sentiment`, `Relevance`, `Language`, `Tag`, `Author`, `Engaged`, `StartDate`, `EndDate`, `MinXFollowers`, `MaxXFollowers`. Field names are case-sensitive. example: Keywords type: string values: description: >- Values to match. Most fields accept comma-separated values (IDs for `Keywords`, uppercase enum values for `Source`, `Sentiment`, etc.). Prefix the field name with `!` on the parent form to invert. example: 42,43 type: string required: - field - values additionalProperties: false AdvancedFilterGroupOutput: type: object properties: group_operator: description: How conditions *within* this group combine. type: string enum: - AND - OR conditions: description: Conditions inside this group. type: array items: $ref: '#/components/schemas/AdvancedFilterConditionOutput' isSingleCondition: description: >- UI hint. When `true`, the group was created from a single condition in the builder. type: boolean required: - group_operator - conditions additionalProperties: false AdvancedFilterConditionOutput: type: object properties: field: description: >- Field name to filter on. Common values: `Keywords`, `Source`, `Sentiment`, `Relevance`, `Language`, `Tag`, `Author`, `Engaged`, `StartDate`, `EndDate`, `MinXFollowers`, `MaxXFollowers`. Field names are case-sensitive. type: string operator: description: >- Comparison operator. `in`/`not in` work with comma-separated `values`; `equals`/`=`/`>=`/`<=` treat `values` as a single scalar. type: string enum: - in - not in - equals - '>=' - <= - '=' values: description: >- Comma-separated values for `in`/`not in`, single value for comparisons. example: 42,43 type: string required: - field - operator - values additionalProperties: false securitySchemes: ApiKey: type: http scheme: bearer description: >- Clerk API key. Create one in Settings → API Keys. Pass as `Authorization: Bearer `. ````