> ## Documentation Index > Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Typeahead > Prefix suggestions for a search box (autocomplete/typeahead). Suggests from three namespace-scoped sources concurrently: values of the requested metadata fields (index-backed, with per-value document counts), collection names, and the caller's own recent search queries. A source that cannot answer is dropped and named in ``warnings`` rather than failing the request. ## OpenAPI ````yaml get /v1/retrievers/typeahead openapi: 3.1.0 info: title: Mixpeek API description: >- This is the Mixpeek API, providing access to various endpoints for data processing and retrieval. termsOfService: https://mixpeek.com/terms contact: name: Mixpeek Support url: https://mixpeek.com/contact email: info@mixpeek.com version: '0.82' servers: - url: https://api.mixpeek.com description: Production security: - BearerAuth: [] paths: /v1/retrievers/typeahead: get: tags: - Retrievers summary: Typeahead description: >- Prefix suggestions for a search box (autocomplete/typeahead). Suggests from three namespace-scoped sources concurrently: values of the requested metadata fields (index-backed, with per-value document counts), collection names, and the caller's own recent search queries. A source that cannot answer is dropped and named in ``warnings`` rather than failing the request. operationId: typeahead_v1_retrievers_typeahead_get parameters: - name: q in: query required: true schema: type: string minLength: 1 maxLength: 200 description: The typed prefix. title: Q description: The typed prefix. - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: >- Comma-separated metadata field paths to suggest values from (e.g. `metadata.talent,metadata.production`). Each field should carry a keyword index; at most 5 are consulted. Omit to skip the field-value source. title: Fields description: >- Comma-separated metadata field paths to suggest values from (e.g. `metadata.talent,metadata.production`). Each field should carry a keyword index; at most 5 are consulted. Omit to skip the field-value source. - name: limit in: query required: false schema: type: integer maximum: 50 minimum: 1 description: Max suggestions per source. default: 10 title: Limit description: Max suggestions per source. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TypeaheadResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] NamespaceHeader: [] components: schemas: TypeaheadResponse: properties: query: type: string title: Query description: The prefix that was matched. suggestions: items: type: string type: array title: Suggestions description: Flat ranked suggestion texts across all sources. values: items: $ref: '#/components/schemas/TypeaheadValueSuggestion' type: array title: Values description: Field-value suggestions with per-value document counts. collections: items: $ref: '#/components/schemas/TypeaheadCollectionSuggestion' type: array title: Collections description: Collections whose name matches the prefix. recent_searches: items: type: string type: array title: Recent Searches description: The caller's own recent queries matching the prefix, newest first. warnings: items: type: string type: array title: Warnings description: Sources that could not be consulted this request. type: object required: - query title: TypeaheadResponse description: >- Prefix suggestions for a search box (UF-15). Three sources, each scoped to the caller's namespace and organization: metadata-field values (index-backed facet, prefix-filtered), collection names, and the caller's own recent search queries. ``suggestions`` is the flat ranked convenience list (recent searches first, then field values by count, then collection names, case-insensitively deduplicated). A source that fails or times out is dropped and named in ``warnings`` instead of failing the request. ErrorResponse: properties: success: type: boolean title: Success description: Always false for error responses default: false status: type: integer title: Status description: HTTP status code for this error error: $ref: '#/components/schemas/ErrorDetail' description: Error details payload type: object required: - status - error title: ErrorResponse description: Error response model. examples: - error: details: id: ns_123 resource: namespace message: Namespace not found type: NotFoundError status: 404 success: false HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError TypeaheadValueSuggestion: properties: field: type: string title: Field description: The metadata field path the value came from. value: type: string title: Value description: The suggested value. count: type: integer title: Count description: Documents carrying this value inside the caller's namespace. type: object required: - field - value - count title: TypeaheadValueSuggestion description: A metadata-field value whose text starts with the typed prefix. TypeaheadCollectionSuggestion: properties: collection_id: type: string title: Collection Id description: Collection ID. collection_name: type: string title: Collection Name description: Collection name. type: object required: - collection_id - collection_name title: TypeaheadCollectionSuggestion description: A collection in the caller's namespace whose name matches the prefix. ErrorDetail: properties: message: type: string title: Message description: Human-readable error message type: type: string title: Type description: Stable error type identifier (machine-readable) code: anyOf: - type: string - type: 'null' title: Code description: >- Fine-grained error code for programmatic handling (e.g., namespace_name_taken, feature_extractor_not_found). Present only when consumers may need to branch on a specific error condition. details: anyOf: - additionalProperties: true type: object - type: 'null' title: Details description: >- Optional structured details to help debugging (validation errors, IDs, etc.) type: object required: - message - type title: ErrorDetail description: Error detail model. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: BearerAuth: type: http scheme: bearer description: >- Mixpeek API key, sent as `Authorization: Bearer mxp_sk_...`. Create one in Studio under Settings → API Keys, or with an admin key via `POST /v1/organizations/users/{user_email}/api-keys`. A missing header returns 403; an invalid or revoked key returns 401. NamespaceHeader: type: apiKey in: header name: X-Namespace description: >- Namespace id (`ns_...`), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked `x-mixpeek-namespace-scoped`. ````