Ollang API Reference
List Custom Instructions
Retrieve all custom translation instructions configured for your account
GET
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.
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).