Skip to main content
POST
Attaches a folder-level document to a folder. The document is applied to every project that already exists in the folder and to projects created in it afterwards, including projects created through Direct File Upload. This is the API equivalent of uploading a guideline in the folder’s Guidelines panel in the dashboard. See Memory, Guidelines, and Custom Instructions for how folder-level guidelines interact with project-level guidelines and global custom instructions.
Ollang fetches the document from the URL you supply and stores its own copy, so a short-lived pre-signed URL is fine. The URL only needs to be readable at the moment of the call, and the document stays available to later orders after the signature expires.

Authorizations

This endpoint requires API key authentication. Include your API key in the request header:
  • Header name: X-Api-Key
  • Header value: Your API key from the Ollang dashboard
  • Format: X-Api-Key: your-api-key-here
The API key user needs write access to the folder. Keys without a folder-write role receive a 403.

Path Parameters

string
required
The unique identifier of the folder to attach the document to.

Body Parameters

string
required
A URL Ollang can read the document from, such as a pre-signed S3 URL. Must be http or https, must resolve to a public address, and must return the file without a redirect. The document must be 50 MB or smaller.
string
required
The kind of folder document. One of:
  • guideline — style and tone guidance
  • guideline_glossary — terminology list
  • character_list — character names and notes
string
Display name of the document. Defaults to <folder name>_folder_document.
number
Size of the document in bytes. Ollang records the size of the file it actually fetched, so this value is informational.
string
BCP-47 language tag of the document (e.g. en). When omitted, each project copy uses that project’s source language.

Response

Returns the created folder document.
string
Unique identifier of the folder document. Pass this to Remove Folder Document.
string
Display name of the document.
string
One of guideline, guideline_glossary, or character_list.
string
Location of the stored copy Ollang created.
number
Size of the stored document in bytes.
string
The language supplied with the request, or null.
string
Identifier of the folder the document is attached to.
string
When the document was attached, in ISO 8601 format.