curl -X GET "https://api-integration.ollang.com/integration/custom-instructions" \
-H "X-Api-Key: <your-api-key>"
const response = await fetch(
"https://api-integration.ollang.com/integration/custom-instructions",
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
},
);
const instructions = await response.json();
import requests
headers = {"X-Api-Key": "<your-api-key>"}
response = requests.get(
"https://api-integration.ollang.com/integration/custom-instructions",
headers=headers,
)
instructions = response.json()
[
{
"id": "507f1f77bcf86cd799439011",
"key": "tone_and_register",
"value": "Match the formality level of the source.",
"active": true,
"description": "Tone and register guidelines",
"scopeRefId": "507f1f77bcf86cd799439012",
"createdAt": "2023-10-05T12:34:56.789Z",
"updatedAt": "2023-10-05T12:34:56.789Z"
}
]
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
Ollang API Reference
List Custom Instructions
Retrieve all custom translation instructions configured for your account
GET
/
integration
/
custom-instructions
curl -X GET "https://api-integration.ollang.com/integration/custom-instructions" \
-H "X-Api-Key: <your-api-key>"
const response = await fetch(
"https://api-integration.ollang.com/integration/custom-instructions",
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
},
);
const instructions = await response.json();
import requests
headers = {"X-Api-Key": "<your-api-key>"}
response = requests.get(
"https://api-integration.ollang.com/integration/custom-instructions",
headers=headers,
)
instructions = response.json()
[
{
"id": "507f1f77bcf86cd799439011",
"key": "tone_and_register",
"value": "Match the formality level of the source.",
"active": true,
"description": "Tone and register guidelines",
"scopeRefId": "507f1f77bcf86cd799439012",
"createdAt": "2023-10-05T12:34:56.789Z",
"updatedAt": "2023-10-05T12:34:56.789Z"
}
]
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
Retrieve every custom instruction (translation guidelines) owned by your API key’s account. Use these with the SDK’s
ollang.customInstructions helpers or when you need IDs for updates or deletes.
curl -X GET "https://api-integration.ollang.com/integration/custom-instructions" \
-H "X-Api-Key: <your-api-key>"
const response = await fetch(
"https://api-integration.ollang.com/integration/custom-instructions",
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
},
);
const instructions = await response.json();
import requests
headers = {"X-Api-Key": "<your-api-key>"}
response = requests.get(
"https://api-integration.ollang.com/integration/custom-instructions",
headers=headers,
)
instructions = response.json()
Authorizations
This endpoint requires API key authentication.- Header name:
X-Api-Key - Header value: Your API key from the Ollang dashboard
Response
Returns an array of custom instruction objects.string
Unique identifier of the custom instruction.
string
Machine-friendly name for the instruction (e.g.
tone_and_register).string
The instruction text applied to translation workflows.
boolean
Whether the instruction is currently enabled.
string
Optional human-readable description.
string
Scope reference (client) identifier.
string
Creation timestamp (ISO 8601).
string
Last update timestamp (ISO 8601).
[
{
"id": "507f1f77bcf86cd799439011",
"key": "tone_and_register",
"value": "Match the formality level of the source.",
"active": true,
"description": "Tone and register guidelines",
"scopeRefId": "507f1f77bcf86cd799439012",
"createdAt": "2023-10-05T12:34:56.789Z",
"updatedAt": "2023-10-05T12:34:56.789Z"
}
]
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
Was this page helpful?