# Generate document (slug)
- Operation ID: `generateDocumentBySlugGet`
- HTTP method: `GET`
- Path: `/schema-service/v2/documents/{slug}/generate`
- [Human-readable API reference](https://hub.synerise.com/api-reference/asset-management#tag/Documents/operation/generateDocumentBySlugGet)
## Self-contained OpenAPI method
The fenced document below contains this method's documentation and all of its local references. It is self-contained; no category or master specification fetch is required.
```yaml
openapi: 3.0.0
info:
title: Synerise Public API
version: 1.9.1
paths:
/schema-service/v2/documents/{slug}/generate:
get:
tags:
- Documents
summary: Generate document (slug)
description: |
Generate a document. Inserts are processed. If an insert can't be processed, the returned `content` is empty.
If the document includes inserts with a context (for example, `{% customer param %}`), you must authenticate the request with a JWT that provides the context.
If you want to authenticate with a JWT that doesn't provide the required context, you can use the [`POST /v2/documents/{slug}/generate` endpoint](operation/generateDocumentBySlug) to provide the parameter values in the request body.
**IMPORTANT**: When the request's context is a Workspace or Synerise User JWT, only documents with the audience set to `ALL` ("Everyone" in the Synerise Web Application) can be generated.
---
**API consumers:** Workspace (Business Profile), Synerise User, Profile (Client), Anonymous Profile, Incognito Profile
**API key permission required:** `SCHEMA_SERVICE_SCHEMA_READ`
**User role permission required:** `assets_docs: read`
operationId: generateDocumentBySlugGet
security:
- JWT: []
parameters:
- name: slug
in: path
required: true
description: Slug of the document
schema:
type: string
pattern: "[a-z0-9]+(?:-[a-z0-9]+)*"
responses:
"200":
description: Processed JSON content
content:
application/json:
schema:
type: object
description: Processed document
required:
- id
- slug
- schema
- content
properties:
uuid:
type: string
format: uuid
description: UUID of the document
slug:
type: string
description: Slug of the document
example: basket
pattern: "[a-z0-9]+(?:-[a-z0-9]+)*"
schema:
type: string
description: Schema of the document (called "Type" in the Synerise Web Application)
example: containers
content:
description: Content of the document
anyOf:
- type: object
description: The processed JSON content of the document
additionalProperties:
description: JSON keys in the document and their values
example:
someBoolean: true
someString: Lorem ipsum
aNestedDocument:
uuid: 772d94f7-a604-409a-bfa9-24a64b8a5051
slug: apple
schema: fruit
content:
color: red
- type: string
description: Processed string value of a document (for example, a small document which only includes an insert to return an expression result)
"400":
description: See error message for details
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
status:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
"401":
description: "Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc."
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
description: Time when the error occurred
error:
type: string
description: Summary of the error
message:
type: string
description: Description of the problem
status:
type: integer
format: int32
description: HTTP status code
"403":
description: Forbidden; insufficient permissions
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
description: Time when the error occurred
error:
type: string
description: Summary of the error
message:
type: string
description: Description of the problem
status:
type: integer
format: int32
description: HTTP status code
"404":
description: Resource not found
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
status:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
"500":
description: See error message for details
content:
application/json:
schema:
type: object
properties:
timestamp:
type: string
format: date-time
description: Time when the error occurred
errorCode:
type: string
description: |
Code of the error, needed for troubleshooting
See error reference: [https://developers.synerise.com/errors.html](https://developers.synerise.com/errors.html)
status:
type: integer
description: Error's HTTP status code
message:
type: string
description: Description of the problem
x-snr-doc-urls:
- /api-reference/asset-management#tag/Documents/operation/generateDocumentBySlugGet
x-codeSamples:
- lang: cURL
label: cURL
source: |-
curl --request GET \
--url https://api.synerise.com/schema-service/v2/documents/%7Bslug%7D/generate \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
- lang: Python
label: Python
source: |-
import http.client
conn = http.client.HTTPSConnection("api.synerise.com")
headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" }
conn.request("GET", "/schema-service/v2/documents/%7Bslug%7D/generate", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
- lang: JavaScript
label: JavaScript
source: |-
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://api.synerise.com/schema-service/v2/documents/%7Bslug%7D/generate");
xhr.setRequestHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
xhr.send(data);
- lang: Node.js
label: Node.js
source: |-
const http = require("https");
const options = {
"method": "GET",
"hostname": "api.synerise.com",
"port": null,
"path": "/schema-service/v2/documents/%7Bslug%7D/generate",
"headers": {
"Authorization": "Bearer REPLACE_BEARER_TOKEN"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
- lang: PHP
label: PHP
source: |-
setUrl('https://api.synerise.com/schema-service/v2/documents/%7Bslug%7D/generate');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
- lang: Java
label: Java
source: |-
HttpResponse response = Unirest.get("https://api.synerise.com/schema-service/v2/documents/%7Bslug%7D/generate")
.header("Authorization", "Bearer REPLACE_BEARER_TOKEN")
.asString();
servers:
- description: Microsoft Azure EU
url: https://api.synerise.com
- description: Microsoft Azure USA
url: https://api.azu.synerise.com
- description: Google Cloud Platform
url: https://api.geb.synerise.com
tags:
- name: Documents
components:
securitySchemes:
JWT:
type: http
scheme: bearer
description: |-
JWT Bearer token. The header looks like this: `Bearer {JWT}`
Remember to include the space between 'Bearer' and the token.
Generate a token via the **Authorization** endpoints.
```