Skip to main content
POST
Attaches a folder-level document by sending the file itself as multipart/form-data. Use this when you have the file locally and do not want to host it or generate a pre-signed URL first. This is the same operation as Attach Folder Document; only the way you supply the file differs. 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.
Send the file in a form field named file. The file must be smaller than 50 MiB (52,428,800 bytes). Files at or above this limit return 413.

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. Retrieve folder IDs with Retrieve All Folders.

Body Parameters

Send the request as multipart/form-data.
file
required
The document to upload, smaller than 50 MiB (52,428,800 bytes).
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 the uploaded file’s own name.
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, identical to Attach 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.