List retrieval documents

http
GET /projects/{project_reference}/knowledge/retrieval-documents

List retrieval documents. Requires project.knowledge.read.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "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_<prefix>_<secret>` tokens."
  }
}

Parameters

NameLocationRequiredDescription
project_referencepathYesProject ID or slug. A project you cannot read is not_found. The MCP tool requires a signed-in user (a user session or user API key); service and agent-run credentials without a user are unauthenticated.
limitqueryNo
cursorqueryNoOpaque page_info.next from the previous page. A cursor this list did not issue is invalid_input.

Parameter contracts

json
[
  {
    "schema": {
      "type": "string",
      "description": "Project ID or slug. A project you cannot read is not_found. The MCP tool requires a signed-in user (a user session or user API key); service and agent-run credentials without a user are unauthenticated."
    },
    "required": true,
    "description": "Project ID or slug. A project you cannot read is not_found. The MCP tool requires a signed-in user (a user session or user API key); service and agent-run credentials without a user are unauthenticated.",
    "name": "project_reference",
    "in": "path"
  },
  {
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 20,
      "description": "Records per page. Integer from 1 to 100; defaults to 20."
    },
    "required": false,
    "name": "limit",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2048,
      "description": "Opaque page_info.next from the previous page. A cursor this list did not issue returns 400."
    },
    "required": false,
    "description": "Opaque page_info.next from the previous page. A cursor this list did not issue is invalid_input.",
    "name": "cursor",
    "in": "query"
  }
]

Responses

200

A page of retrieval documents.

json
{
  "description": "A page of retrieval documents.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid",
                  "description": "Retrieval document ID."
                },
                "revision": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$",
                  "description": "Opaque revision of this record. Send it as expected_revision to update or delete exactly this version."
                },
                "title": {
                  "type": "string",
                  "description": "Document title."
                },
                "source": {
                  "type": "string",
                  "description": "Upstream source reference, such as a file path or URL; empty when not set."
                },
                "type": {
                  "type": "string",
                  "description": "Document type label; empty when not set."
                },
                "metadata": {
                  "type": "object",
                  "additionalProperties": {},
                  "description": "Structured metadata stored with the record: an object of string keys to JSON values."
                },
                "created_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "When the record was created (RFC 3339, UTC)."
                },
                "updated_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "When the record last changed (RFC 3339, UTC)."
                }
              },
              "required": [
                "id",
                "revision",
                "title",
                "source",
                "type",
                "metadata",
                "created_at",
                "updated_at"
              ]
            },
            "description": "Retrieval document records behind ragStore(), oldest first with ID as tie-breaker. Read the ID and current revision before updating or deleting. Follow the next cursor until null to read every record."
          },
          "page_info": {
            "$ref": "#/components/schemas/PageInfo"
          }
        },
        "required": [
          "data",
          "page_info"
        ]
      }
    }
  }
}

400

invalid_input: invalid limit or cursor

json
{
  "description": "invalid_input: invalid limit or cursor",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

unauthenticated

json
{
  "description": "unauthenticated",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

not_found: project not found or not visible

json
{
  "description": "not_found: project not found or not visible",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

internal

json
{
  "description": "internal",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/schemas/PageInfo

json
{
  "type": "object",
  "properties": {
    "self": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor pointing to the current page"
    },
    "first": {
      "type": "null",
      "description": "First page cursor (always null for cursor-based pagination)"
    },
    "next": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor for the next page (null if no more pages)"
    },
    "prev": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor for the previous page (null if on first page)"
    }
  },
  "required": [
    "self",
    "first",
    "next",
    "prev"
  ]
}

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "listRetrievalDocuments",
  "tags": [
    "knowledge/Documents/Retrieval documents"
  ],
  "summary": "List retrieval documents",
  "description": "List retrieval documents. Requires project.knowledge.read.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "description": "Project ID or slug. A project you cannot read is not_found. The MCP tool requires a signed-in user (a user session or user API key); service and agent-run credentials without a user are unauthenticated."
      },
      "required": true,
      "description": "Project ID or slug. A project you cannot read is not_found. The MCP tool requires a signed-in user (a user session or user API key); service and agent-run credentials without a user are unauthenticated.",
      "name": "project_reference",
      "in": "path"
    },
    {
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 20,
        "description": "Records per page. Integer from 1 to 100; defaults to 20."
      },
      "required": false,
      "name": "limit",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 2048,
        "description": "Opaque page_info.next from the previous page. A cursor this list did not issue returns 400."
      },
      "required": false,
      "description": "Opaque page_info.next from the previous page. A cursor this list did not issue is invalid_input.",
      "name": "cursor",
      "in": "query"
    }
  ],
  "responses": {
    "200": {
      "description": "A page of retrieval documents.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid",
                      "description": "Retrieval document ID."
                    },
                    "revision": {
                      "type": "string",
                      "pattern": "^[a-f0-9]{64}$",
                      "description": "Opaque revision of this record. Send it as expected_revision to update or delete exactly this version."
                    },
                    "title": {
                      "type": "string",
                      "description": "Document title."
                    },
                    "source": {
                      "type": "string",
                      "description": "Upstream source reference, such as a file path or URL; empty when not set."
                    },
                    "type": {
                      "type": "string",
                      "description": "Document type label; empty when not set."
                    },
                    "metadata": {
                      "type": "object",
                      "additionalProperties": {},
                      "description": "Structured metadata stored with the record: an object of string keys to JSON values."
                    },
                    "created_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "When the record was created (RFC 3339, UTC)."
                    },
                    "updated_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "When the record last changed (RFC 3339, UTC)."
                    }
                  },
                  "required": [
                    "id",
                    "revision",
                    "title",
                    "source",
                    "type",
                    "metadata",
                    "created_at",
                    "updated_at"
                  ]
                },
                "description": "Retrieval document records behind ragStore(), oldest first with ID as tie-breaker. Read the ID and current revision before updating or deleting. Follow the next cursor until null to read every record."
              },
              "page_info": {
                "$ref": "#/components/schemas/PageInfo"
              }
            },
            "required": [
              "data",
              "page_info"
            ]
          }
        }
      }
    },
    "400": {
      "description": "invalid_input: invalid limit or cursor",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "unauthenticated",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "not_found: project not found or not visible",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "internal",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Project documents",
  "x-canonical-documentation": {
    "domain": "knowledge",
    "resource": "Documents",
    "subgroup": "Retrieval documents",
    "name": "List retrieval documents",
    "description": "List retrieval documents. Requires project.knowledge.read.",
    "operationId": "listRetrievalDocuments"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/knowledge-documents-retrieval-documents/list-retrieval-documents"
  }
}