Skip to main content
POST
/
integration
/
custom-instructions
curl -X POST "https://api-integration.ollang.com/integration/custom-instructions" \
  -H "X-Api-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "tone_and_register",
    "value": "Match the formality level of the source. Business emails should remain professional.",
    "description": "Instructions for maintaining appropriate tone and register"
  }'

{
  "id": "507f1f77bcf86cd799439011",
  "key": "tone_and_register",
  "value": "Match the formality level of the source. Business emails should remain professional.",
  "active": true,
  "description": "Instructions for maintaining appropriate tone and register",
  "scopeRefId": "507f1f77bcf86cd799439012",
  "createdAt": "2023-10-05T12:34:56.789Z",
  "updatedAt": "2023-10-05T12:34:56.789Z"
}
Create a custom instruction string (guideline) that can influence how translations are produced for your projects. 
curl -X POST "https://api-integration.ollang.com/integration/custom-instructions" \
  -H "X-Api-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "tone_and_register",
    "value": "Match the formality level of the source. Business emails should remain professional.",
    "description": "Instructions for maintaining appropriate tone and register"
  }'

​
Authorizations

This endpoint requires API key authentication.

​
Body Parameters

​
key
string
required
Machine-friendly identifier for this instruction (e.g. tone_and_register).
​
value
string
required
The full instruction text.
​
description
string
Optional longer description of what this instruction controls.

​
Response

Returns the created custom instruction, including id, timestamps, and scopeRefId. Same shape as List Custom Instructions. 
{
  "id": "507f1f77bcf86cd799439011",
  "key": "tone_and_register",
  "value": "Match the formality level of the source. Business emails should remain professional.",
  "active": true,
  "description": "Instructions for maintaining appropriate tone and register",
  "scopeRefId": "507f1f77bcf86cd799439012",
  "createdAt": "2023-10-05T12:34:56.789Z",
  "updatedAt": "2023-10-05T12:34:56.789Z"
}