> ## Documentation Index > Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Lookup project knowledge > Search compact knowledge frontmatter across knowledge markdown files with cursor pagination, optional sharding, and explicit preview/environment/release targeting. ## OpenAPI ````yaml https://api.veryfront.com/openapi.json post /projects/{project_reference}/knowledge/lookup openapi: 3.1.0 info: title: Veryfront REST API version: 1.0.0 summary: Domain-first REST reference for the maintained Veryfront HTTP API surface. description: >- Project-first HTTP API for Veryfront project resources. Root account/platform endpoints that still appear in this reference are transitional compatibility surfaces unless the canonical inventory marks them otherwise. ## Start here - **Interactive REST reference:** [/docs](/docs) - **Raw OpenAPI document:** [/openapi.json](/openapi.json) - **Canonical inventory:** `docs/api-surface-inventory.md` in this repository - **GraphQL endpoint:** [/graphql](/graphql) - **MCP playground:** [/mcp/playground](/mcp/playground) ## Authentication Use one of these request headers: - `Authorization: Bearer ` - `Authorization: Bearer vf__` - `X-API-Key: vf__` JWTs must use the Bearer token contract. API keys work in either the Bearer header or `X-API-Key`. ## Discovery model Veryfront is one platform with multiple access modes: - **REST** for resource-oriented and operational HTTP workflows - **GraphQL** for connected app-facing data and typed mutations - **MCP** for tool-style automation and agent workflows For the fastest path through the platform, start with the project-scoped domain groups. Transitional account/platform groups are retained for compatibility and follow the removal register in the canonical inventory. contact: name: Veryfront API Support url: https://veryfront.com/docs email: support@veryfront.com servers: - url: https://api.veryfront.com description: Current request origin - url: http://localhost:4000 description: Local development security: - bearerAuth: [] - apiKeyAuth: [] tags: - name: Projects description: Core project operations - name: Account description: >- Transitional account-level users and settings retained for dashboard compatibility - name: Project Users description: Project members and invites - name: Members description: Project members and invites - name: Files description: Main branch files - name: Branch Files description: Files on branches - name: Environment Files description: Files in environments - name: Release Files description: Files in releases - name: Uploads description: File uploads and assets - name: Branches description: Content branches for previews - name: Releases description: Published file snapshots - name: Deployments description: Connect releases to environments - name: Environments description: Deployment targets and variables - name: Environment Variables description: Project environment variable management - name: Domains description: Custom domains for environments - name: Project Servers description: Project-scoped dedicated server instances - name: Root Servers description: >- Transitional root dedicated-server administration retained for compatibility - name: Tasks description: Project tasks - name: Evals description: Project eval definitions and eval run projections - name: Workflows description: Project workflows - name: Workflow Runs description: Workflow run history and status - name: Schedules description: Recurring project automation schedules - name: Webhooks description: Webhook-triggered automation entry points - name: Skills description: Project skills - name: Prompts description: Project prompts - name: Tools description: Project tools - name: Resources description: Project-defined resource documents and source-backed resource definitions - name: Sandboxes description: Ephemeral sandbox execution environments - name: Search description: Text and vector search - name: Knowledge description: Knowledge manifest lookup across project knowledge files - name: Chunks description: File chunks for search indexing - name: Embeddings description: Vector embeddings - name: RAG Documents description: Project retrieval-augmented knowledge documents - name: Style Artifacts description: Project style artifact state and build outputs - name: External Storage description: Transitional connected cloud-provider file operations - name: Project Cache description: Project-scoped distributed cache operations - name: User Cache description: Transitional user cache helpers retained for compatibility - name: API Keys description: >- Transitional user/account API key management; prefer project-scoped keys for public integrations - name: User description: Transitional current-user profile endpoint for first-party clients - name: Favorites description: Transitional user favorites for first-party dashboard clients - name: Subscriptions description: Transitional account billing and subscription workflows - name: Credits description: Transitional account credit balance, purchase, and insufficiency flows - name: Usage description: >- Project/account usage limits and warnings; account-level usage is transitional - name: Gates description: Transitional plan and feature gate checks for first-party clients - name: Channels description: Project channel integrations and delivery settings - name: Agents description: Project agents - name: Agent Templates description: >- Public template catalog of addable agents assembled from curated template projects - name: Agent Workers description: Internal/transitional agent worker leases and sessions - name: Agent Runtimes description: Registered push-based agent runtime services and runtime target health - name: Project Integrations description: Project-scoped integration catalog and configuration - name: Integrations description: Transitional external integration catalog for first-party clients - name: Connections description: Viewer-visible project and project-user integration connections - name: Integration Tools description: >- Transitional dynamic integration tool listing, invocation, and connection state - name: OAuth description: >- Transitional OAuth integration flows for first-party and connected-app clients - name: Templates description: Transitional starter-template discovery used during project creation - name: AI description: >- Transitional platform AI gateway/model helpers; project AI assets use project-scoped routes - name: Images description: Generated images and image assets - name: Conversations description: Transitional conversation/run-control HTTP surface for first-party clients - name: Runs description: Transitional hosted run-control endpoints for conversation execution - name: MCP description: >- MCP catalog/playground helpers; primary MCP traffic uses the streamable MCP handler - name: Logs description: Project log queries via Loki - name: Metrics description: Project metric queries via a Prometheus-compatible backend - name: Traces description: Project trace queries via Grafana Tempo - name: Errors description: Internal/public error type catalog (RFC 9457) - name: Authentication description: Transitional auth token, login, logout, magic-link, and JWKS flows externalDocs: description: Interactive REST reference url: https://api.veryfront.com/docs paths: /projects/{project_reference}/knowledge/lookup: post: tags: - Knowledge summary: Lookup project knowledge description: >- Search compact knowledge frontmatter across knowledge markdown files with cursor pagination, optional sharding, and explicit preview/environment/release targeting. operationId: lookupProjectKnowledge parameters: - schema: type: string description: Project ID or slug. required: true name: project_reference in: path requestBody: content: application/json: schema: type: object properties: query: type: string minLength: 1 maxLength: 500 description: Text to match against knowledge frontmatter. cursor: type: string minLength: 1 maxLength: 13334 description: >- Opaque pagination token. Omit on the first request — only pass a value returned verbatim in a previous response's page_info.next. lookup_target: oneOf: - type: object properties: kind: type: string enum: - preview_branch description: Provide the kind. branch_id: type: string nullable: true format: uuid description: >- Branch to search. Omit or use null for the main branch (the default). required: - kind additionalProperties: false description: >- Search a working branch — the default scope when lookup_target is omitted. - type: object properties: kind: type: string enum: - environment description: Provide the kind. environment_id: type: string format: uuid description: >- ID of the environment whose deployed release to search. environment_name: type: string minLength: 1 maxLength: 255 description: >- Name of the environment (for example "production") whose deployed release to search. required: - kind additionalProperties: false description: >- Search the release currently deployed to an environment. Provide environment_id or environment_name. - type: object properties: kind: type: string enum: - release description: Provide the kind. release_id: type: string format: uuid description: ID of the release to search. release_version: type: string minLength: 1 maxLength: 255 description: Version string of the release to search. required: - kind additionalProperties: false description: >- Search a specific published release. Provide release_id or release_version. description: >- Optional. Omit to search the current branch (the default). Only set this to target a specific deployed environment or release. limit: type: integer minimum: 1 maximum: 12 description: Maximum number of results to return. shard_count: type: integer minimum: 1 maximum: 8 description: Provide the shard count. shard_index: type: integer minimum: 0 description: Provide the shard index. additionalProperties: false responses: '200': description: Knowledge lookup results. content: application/json: schema: type: object properties: query: type: string description: Query string associated with this result. mode: type: string enum: - search - browse description: The mode associated with this tool result. data: type: array items: type: object properties: path: type: string description: The path associated with this tool result. matched_fields: type: array items: type: string description: >- One matched field item associated with this tool result. description: >- List of matched fields associated with this tool result. frontmatter: type: array items: type: object properties: key: type: string description: The key associated with this tool result. value: type: string description: The value associated with this tool result. required: - key - value description: >- One frontmatter item associated with this tool result. description: >- List of frontmatter associated with this tool result. required: - path - matched_fields - frontmatter description: One data item associated with this tool result. description: Primary result records returned by the tool. page_info: type: object properties: self: type: string nullable: true description: Cursor that refers to the current page. first: type: object nullable: true enum: - null description: The first associated with this tool result. next: type: string nullable: true description: Cursor for the next page when pagination is available. prev: type: string nullable: true description: >- Cursor for the previous page when pagination is available. required: - self - first - next - prev description: Pagination cursor values for traversing the result set. returned: type: integer minimum: 0 description: The returned associated with this tool result. total_matches: type: integer minimum: 0 description: Total number of matches found by the tool. shard: type: object properties: shard_index: type: integer minimum: 0 description: The shard index associated with this tool result. shard_count: type: integer minimum: 1 description: The shard count associated with this tool result. total_items: type: integer minimum: 0 description: The total items associated with this tool result. required: - shard_index - shard_count - total_items description: Structured shard details associated with this tool result. required: - query - mode - data - page_info - returned - total_matches - shard '400': description: Invalid request '401': description: Unauthorized '403': description: Forbidden '404': description: Project or branch not found components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT or API Key description: >- Use a JWT bearer token or a Veryfront API key in the Authorization header. apiKeyAuth: type: apiKey in: header name: X-API-Key description: Alternative API key header for vf__ tokens. ````