> ## 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.

# Update a retrieval document

> Update retrieval document.

`updateRetrievalDocument(projectReference: ID!, retrievalDocumentId: ID!, input: UpdateRetrievalDocumentInput!): RetrievalDocument!`

Requires project.knowledge.write.

## Arguments

| Argument | Type | Required | Description |
| - | - | - | - |
| `projectReference` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes | Project UUID or slug. |
| `retrievalDocumentId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes | |
| `input` | [`UpdateRetrievalDocumentInput!`](https://veryfront.com/docs/cloud/graphql/types/updateretrievaldocumentinput) | Yes | |

## Input fields

### input

[`UpdateRetrievalDocumentInput`](https://veryfront.com/docs/cloud/graphql/types/updateretrievaldocumentinput)

| Field | Type | Required | Description |
| - | - | - | - |
| `expectedRevision` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes | The revision you read. A changed record is a conflict; a missing record is not\_found. Title, source, type and metadata are replaced, and the response includes the new revision. |
| `title` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes | |
| `source` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No | Defaults to an empty string. |
| `type` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No | Defaults to an empty string. |
| `metadata` | [`JSONObject`](https://veryfront.com/docs/cloud/graphql/types/jsonobject) | No | |

## Response

Returns [`RetrievalDocument!`](https://veryfront.com/docs/cloud/graphql/types/retrievaldocument). Open the type for its fields and nested types.

| Field | Type | Description |
| - | - | - |
| `id` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | |
| `revision` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Opaque revision: 64 lowercase hexadecimal characters. Send it as expectedRevision. |
| `title` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `source` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `type` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `metadata` | [`JSONObject!`](https://veryfront.com/docs/cloud/graphql/types/jsonobject) | |
| `createdAt` | [`DateTime!`](https://veryfront.com/docs/cloud/graphql/types/datetime) | |
| `updatedAt` | [`DateTime!`](https://veryfront.com/docs/cloud/graphql/types/datetime) | |

Types marked with `!` cannot be null. Lists use `[Type]` notation. The [type index](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
mutation UpdateRetrievalDocument($projectReference: ID!, $retrievalDocumentId: ID!, $input: UpdateRetrievalDocumentInput!) {
  updateRetrievalDocument(projectReference: $projectReference, retrievalDocumentId: $retrievalDocumentId, input: $input) {
    id
    createdAt
    updatedAt
    metadata
    revision
  }
}
```

```json title="variables.json" theme={null}
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "retrievalDocumentId": "00000000-0000-4000-8000-000000000001",
  "input": {
    "expectedRevision": "example",
    "title": "example"
  }
}
```

<details>
  <summary>Try this mutation</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Mutation

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.