Create a retrieval document - Veryfront

createRetrievalDocument(projectReference: ID!, input: CreateRetrievalDocumentInput!): RetrievalDocument!

Requires project.knowledge.write.

Arguments

Argument	Type	Required	Description
`projectReference`	`ID!`	Yes	Project UUID or slug.
`input`	`CreateRetrievalDocumentInput!`	Yes

Input fields

input

CreateRetrievalDocumentInput

Field	Type	Required	Description
`id`	`ID`	No	Caller-chosen record ID. Omit to let the API choose one. An ID that already exists is a conflict. Create the record before writing its chunks; use update to change an existing record.
`title`	`String!`	Yes
`source`	`String`	No	Defaults to an empty string.
`type`	`String`	No	Defaults to an empty string.
`metadata`	`JSONObject`	No

Response

Returns RetrievalDocument!. Open the type for its fields and nested types.

Field	Type	Description
`id`	`ID!`
`revision`	`String!`	Opaque revision: 64 lowercase hexadecimal characters. Send it as expectedRevision.
`title`	`String!`
`source`	`String!`
`type`	`String!`
`metadata`	`JSONObject!`
`createdAt`	`DateTime!`
`updatedAt`	`DateTime!`

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

mutation CreateRetrievalDocument($projectReference: ID!, $input: CreateRetrievalDocumentInput!) {
  createRetrievalDocument(projectReference: $projectReference, input: $input) {
    id
    createdAt
    updatedAt
    metadata
    revision
  }
}

{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "input": {
    "title": "example"
  }
}