Search files
Hybrid (vector + keyword) search across accessible files. Results are ranked by relevance and capped at 100.
User-scoped keys search all files the user can read. Org-scoped keys search all non-access-controlled files in the organization.
Pass scope (user-scoped keys only) to constrain the search to one of the three top-level meta-collections shown in the GC AI UI:
- my-files: files in the user's personal "My Files" tree
- shared-with-me: files explicitly shared with the user (and files inside shared folders)
- organization: files in the organization's "Organization Files" tree
Pass project_id (user- or org-scoped keys) to constrain the search to the files linked to one project, e.g. searching a project of contracts for specific terms. Mutually exclusive with scope. To list a project's files without a query, use GET /projects/{id}/files instead.
Request
- Base URLhttps://app.gc.ai/api/external/v1
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Search query (required)
Optional scope filter (user-scoped keys only). When omitted, searches all files the user can read. Mutually exclusive with project_id.
Optional project filter. Constrains the search to files linked to this project. Mutually exclusive with scope.
Response
Files matching the query, ranked by relevance
Changes
No recorded changes to this operation across all 1 revision of this API.