Skip to main content
GET
/
integration
/
custom-instructions
curl -X GET "https://api-integration.ollang.com/integration/custom-instructions" \
  -H "X-Api-Key: <your-api-key>"

[
  {
    "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"
  }
]
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>"

​
Authorizations

This endpoint requires API key authentication.

​
Response

Returns an array of custom instruction objects.
​
id
string
Unique identifier of the custom instruction.
​
key
string
Machine-friendly name for the instruction (e.g. tone_and_register).
​
value
string
The instruction text applied to translation workflows.
​
active
boolean
Whether the instruction is currently enabled.
​
description
string
Optional human-readable description.
​
scopeRefId
string
Scope reference (client) identifier.
​
createdAt
string
Creation timestamp (ISO 8601).
​
updatedAt
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"
  }
]