Create a new document

Creates a new document with the specified configurations and returns the document details including the generated document ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The unique identifier for the new application.

Body Params
string
required

The name of the document.

string
enum
required

The source type of the document.

Allowed:
string

The source of the document (e.g., URL, file path).

string
enum
Defaults to NEVER

How often to refresh the document.

Allowed:
config
object

Source-specific configuration options.

documentMetadata
object

Document metadata including RBAC (Role-Based Access Control) configuration.

RBAC Fields:

  • visibilityMode (string): Controls document visibility. Values: "public" (default) or "restricted".
  • accessFilters (array of strings): Access control tags/labels for filtering. Required when visibilityMode is "restricted".

Default behavior: If not provided, defaults to {"visibilityMode":"public","accessFilters":[]}.

Validation: Documents with visibilityMode: "restricted" MUST include at least one value in accessFilters, otherwise the API will reject the request with a 422 error.

Additional fields: You can include other custom metadata fields (e.g., source, relatedDocuments, etc.) as needed.

Example:

{
  "visibilityMode": "restricted",
  "accessFilters": ["tier1", "compliance", "rrhh"],
  "source": "intranet",
  "category": "policies"
}
string

Preferred time of day for updates/refresh.

string | null

The expiration date of the document.

string | null

The ID of the ingestion source.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json