Translation

Run Stage 2 translation

Transforms input into an audience-specific technical document. Requires the optimize:write scope and the apiAccess feature.

post/api/v1/translate

Request

  • Base URL: https://www.devspeak.dev
  • URL: https://www.devspeak.dev/api/v1/translate
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

inputstring required
audience'Junior Dev' | 'Senior Dev' | 'Tech Lead' | 'SRE' | 'Data Engineer' required
context'Backend' | 'Frontend' | 'Mobile' | 'Data/ML' | 'DevOps' required
format'Technical Spec' | 'Jira Tickets' | 'API Design' | 'RFC' | 'Data Model' | 'Prompt' | 'Optimize' required
toneinteger required
customInstructionsstring
workspaceContextstring
translationIdstring
correctionsOnlyboolean

Only with format "Optimize", which returns the input improved in its own language instead of a document. true fixes spelling, grammar and punctuation only.

Response

Generated translation

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.