Translation API Documentation
Connect your applications, content platforms, and enterprise systems to scalable translation and localization workflows with the Stepes API.
Submit multilingual content, configure translation requirements, track processing, retrieve completed translations, and automate global content operations through one consistent developer framework.
Start Building with the Translation API
Choose the technical path that matches your implementation stage, from secure access and first requests to endpoint-level reference and production support.
Get Started
Understand the API model, prepare your environment, and complete your first translation workflow.
Explore the QuickstartAuthentication
Learn how API credentials are issued, protected, used, rotated, and revoked.
View Authentication GuidanceAPI Reference
Explore endpoints, parameters, request schemas, responses, errors, and availability details.
Explore the API ReferenceDeveloper Support
Get implementation guidance for architecture, testing, production readiness, and deployment.
Get Developer SupportHow the Translation API Works
The Translation API uses a consistent resource and job model for content submission, workflow routing, status tracking, review, event delivery, and completed multilingual output.
Explore Core API ConceptsAuthenticate
Establish secure access with organization-approved credentials and permissions.
Create a Request
Define the translation project, business context, and source-language requirements.
Submit Content
Send text, structured data, localization files, or supported business documents.
Configure the Workflow
Select target languages, translation methods, terminology, review, and delivery needs.
Monitor Processing
Track projects, jobs, reviews, quality checks, and delivery status through the API.
Retrieve Results
Return completed multilingual content to the system, repository, or team that needs it.
From Request Creation to Completed Delivery
Implement one reliable end-to-end workflow first, then add event handling, language assets, review stages, and higher-volume operational controls.
Quickstart
Send Your First Translation Request
Follow a focused path from secure API access to completed multilingual output before adding advanced workflow configuration and automation.
-
01
Request and securely store your API credentials.
-
02
Connect to the appropriate API environment.
-
03
Authenticate your first request.
-
04
Create a translation project and submit content.
-
05
Monitor processing and retrieve the completed output.
curl --request POST \
--url "$STEPES_API_BASE_URL/v3/projects" \
--header "Authorization: Bearer $STEPES_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"source_locale": "en-US",
"target_locales": ["de-DE", "ja-JP"],
"workflow": "translation_review",
"content": {
"type": "text",
"value": "Welcome to our product."
}
}'const response = await fetch(
`${process.env.STEPES_API_BASE_URL}/v3/projects`,
{
method: "POST",
headers: {
Authorization: `Bearer ${process.env.STEPES_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
source_locale: "en-US",
target_locales: ["de-DE", "ja-JP"],
workflow: "translation_review",
content: {
type: "text",
value: "Welcome to our product.",
},
}),
}
);
const project = await response.json();import os
import requests
response = requests.post(
f"{os.environ['STEPES_API_BASE_URL']}/v3/projects",
headers={
"Authorization": f"Bearer {os.environ['STEPES_API_KEY']}",
"Content-Type": "application/json",
},
json={
"source_locale": "en-US",
"target_locales": ["de-DE", "ja-JP"],
"workflow": "translation_review",
"content": {
"type": "text",
"value": "Welcome to our product.",
},
},
)
project = response.json(){
"id": "prj_84K2",
"status": "accepted",
"source_locale": "en-US",
"target_locales": ["de-DE", "ja-JP"]
}
Confirm production endpoint availability, authentication requirements, schemas, and environment details in the API Reference before implementation.
Developer Documentation
Documentation by Category
Find the technical guidance, workflow documentation, and reference material needed to design, build, and operate your Stepes integration.
Getting Started
Understand the API architecture, obtain access, configure your environment, and complete your first workflow.
Authentication and Access
Authenticate requests and manage credentials securely across development and production environments.
Translation Workflows
Create, configure, submit, monitor, and complete translation projects through one workflow model.
- Create Translation Projects
- Submit Translation Requests
- Configure Workflow Options
- Retrieve Status and Results
Files and Content
Prepare and submit text, documents, structured content, and localization resources for translation.
Languages and Locales
Use consistent language and locale identifiers across requests and multilingual delivery workflows.
Project Status and Webhooks
Track long-running translation jobs and build event-driven delivery workflows with status resources and webhooks.
Errors and Production Operations
Build reliable integrations that handle validation, failures, retries, duplicate requests, and limits.
API Reference
Explore endpoint-level documentation for every supported Stepes API resource and operation.
Core API Resources
Explore the Stepes API Resource Model
Consistent, reusable resources make it easier to build focused translation requests today and expand into advanced enterprise localization workflows over time.
Organizations and Workspaces
Represent the teams, business units, environments, and operational areas using the Stepes platform.
Projects
Group related content, target languages, workflow requirements, schedules, and delivery expectations.
Content and Files
Represent the text, documents, localization resources, and structured data submitted for translation.
Languages and Workflows
Define locale requirements and control how content moves through translation, review, and approval.
Jobs, Reviews, and Quality
Represent language-specific processing activities, linguistic reviews, and quality evaluations.
Deliveries, Events, and Usage
Provide completed outputs, operational updates, and the visibility needed to manage integrations.
Content and Quality
Configure Content, Context, and Quality
Submit text, structured content, software resources, documents, and recurring updates with the context, terminology, workflow, and review controls required for reliable multilingual output.
Content Inputs
Bring multilingual processing closer to the systems where your organization creates and manages content.
Text and Structured Content
Translate interface text, database content, customer communications, product information, and structured application data.
Business Documents
Submit documents used by marketing, operations, legal, support, product, engineering, and other enterprise teams.
Software and Application Content
Connect software strings, mobile resources, release content, and localization files with automated workflows.
Website and Digital Content
Translate web pages, campaign content, product information, articles, and recurring publishing updates.
Technical Documentation
Process manuals, instructions, specifications, knowledge articles, support documentation, and product materials.
Recurring Content Updates
Automate high-frequency translation workflows for content that changes continuously across systems and markets.
Match the Workflow to the Content
Configure translation and review steps according to business risk, turnaround requirements, subject matter, and intended use.
AI Translation
Accelerate multilingual processing for content suited to controlled automated translation.
Professional Human Translation
Route content to qualified linguists when professional translation expertise is required.
Post-Editing and Linguistic Review
Combine automation with review for accuracy, fluency, terminology, style, and completeness.
Terminology and Translation Memory
Apply approved language assets to strengthen consistency and reuse previously validated content.
Subject-Matter Expertise
Support technical, medical, legal, financial, and other specialized content requirements.
Quality Assurance and Approval
Connect structured checks, stakeholder review, and approval before multilingual delivery.
Developers work with a consistent API framework while business and localization teams apply the appropriate translation workflow.
Integration Patterns
Common Translation API Integration Patterns
Use stable identifiers, asynchronous jobs, webhook events, and predictable delivery patterns to connect translation workflows with the systems that create and manage content.
Stepes Translation API
Submit content, configure workflows, monitor processing, and return completed translations to the systems your teams already use.
Content Management Systems
Translate website, campaign, editorial, and publishing content as it is created or updated.
Software and Application Localization
Connect product repositories, development workflows, application platforms, and release processes.
Product Information Management
Automate multilingual product descriptions, catalogs, attributes, specifications, and commerce content.
Technical Documentation Systems
Submit manuals, knowledge articles, service documentation, and recurring technical updates.
Multilingual Customer Support
Connect support platforms, help centers, knowledge bases, and customer communication systems.
Continuous Localization
Coordinate frequent content changes with automated translation, review, testing, and delivery.
Enterprise Content Operations
Standardize translation intake and delivery across departments, systems, markets, and content types.
Enterprise Reliability
Design Secure, Reliable Production Integrations
Protect credentials and content while designing for asynchronous processing, safe retries, request traceability, webhook verification, and verified multilingual delivery.
Authentication, Security, and Governance
Protect credentials, control access, and align API activity with enterprise data-handling and governance requirements.
Credential Protection
Store API credentials securely and restrict access to approved applications and environments.
Encrypted Communication
Protect content and request data during transmission between your systems and the Stepes API.
Access Permissions
Align API access with organizational roles, environments, and approved integration responsibilities.
Credential Lifecycle
Plan for credential issuance, rotation, revocation, and changes in application ownership.
Environment Separation
Keep development, testing, and production activity appropriately separated.
Data Handling and Auditability
Support traceable API activity and enterprise review of content-handling requirements.
Production Reliability
Design for long-running workflows, predictable failures, safe recovery, traceability, and verified multilingual delivery.
Asynchronous Processing
Monitor translation, review, quality assurance, and approval workflows that complete over time.
Structured Error Handling
Use consistent response information to identify and resolve request and workflow problems.
Safe Retries
Recover from temporary failures without creating unintended duplicate projects or submissions.
Idempotent Operations
Protect workflows when network conditions or application behavior repeat the same request.
Rate and Usage Management
Design high-volume integrations to respond predictably to operational limits.
Request Traceability
Use request identifiers and logs to support monitoring, troubleshooting, and technical support.
Delivery Verification
Confirm that completed content is associated with the correct project, language, and source.
Developer Resources
Tools for Faster Implementation
Bring reference material, implementation guidance, API updates, and lifecycle information together in one consistent developer experience.
Interactive API Reference
Explore endpoints, parameters, schemas, responses, errors, and related operations.
Machine-Readable API Specification
Use a standardized API definition to support development tools, validation, testing, and planning.
Tested Code Examples
Review practical examples for common requests and complete translation workflows.
Workflow and Implementation Guides
Follow task-oriented guidance that connects multiple API operations into useful business processes.
Changelog and Migration Guidance
Track API improvements, material changes, deprecations, replacement resources, and migration needs.
API Status and Support
Access operational information and the appropriate support path for production integrations.
Build on a Stable, Transparent API
Clear lifecycle labels communicate the maturity, availability, and support expectations of each API capability.
Preview
Available for controlled evaluation and feedback while the API contract continues to evolve.
Beta
Available for active implementation while final production behavior is being refined.
Generally Available
Production-ready, documented, and supported for enterprise implementation.
Deprecated
Still available during a defined transition period with replacement and migration guidance.
Retired
No longer available after the communicated support and migration period has ended.
Version information, deprecation notices, replacement guidance, and migration resources help enterprise teams plan controlled updates.
Get Implementation Support When You Need It
Work with Stepes developer and localization specialists on architecture, workflow design, security review, testing, production readiness, and operational optimization.
Solution Architecture
Map Translation API resources, identifiers, events, and security controls to your applications and content systems.
Workflow Design
Define how AI translation, professional review, terminology, quality assurance, and approval work together.
API Onboarding
Prepare credentials, environments, access controls, documentation, and the initial development path.
Integration Testing
Validate requests, responses, files, locale handling, status transitions, events, errors, and multilingual outputs.
Production Readiness
Review reliability, monitoring, security, escalation, and deployment requirements before launch.
Prepare a Reliable Production Integration
Get technical guidance for architecture, workflow configuration, security review, testing, launch, and operational troubleshooting.
Explore the Stepes Developer Ecosystem
Continue into shared developer services and adjacent Stepes integration products without leaving the developer documentation architecture.
Developers Hub
Explore Stepes developer products, shared services, implementation guidance, and operational resources.
Open Developers HubWebsite Translation Proxy
Implement and operate proxy-based multilingual website delivery through the Stepes developer ecosystem.
Open Website Translation ProxySoftware Localization API
Automate software resource exchange, localization processing, status tracking, and localized delivery.
Open Software Localization APIIntegrations
Connect Stepes with content, product, development, support, and enterprise business systems.
Open IntegrationsWebhooks
Receive signed events for asynchronous processing, reviews, exceptions, and completed deliveries.
Open WebhooksDeveloper Security
Review authentication, credential handling, webhook verification, access controls, and secure implementation guidance.
Open Developer SecurityTranslation API Questions
Review the implementation decisions developers most often need to make before moving into the detailed documentation.
Contact Developer SupportStart with the Translation API quickstart to review access requirements, authentication, the core resource model, content submission, job monitoring, and result retrieval.
Open the QuickstartAPI access is issued for approved integrations. Store credentials in a secure server-side secret manager, restrict them to authorized environments, rotate them when appropriate, and never expose them in public client code.
Review AuthenticationThe Translation API supports workflows for text, structured content, localization resources, business documents, and other supported inputs. Current formats, validation rules, and limits belong in the Files and Content documentation.
Review Files and ContentUse synchronous processing for eligible requests that can complete within the request lifecycle. Use asynchronous jobs for larger payloads, multiple target languages, file processing, professional review, or any workflow that may continue over time.
Explore Translation WorkflowsYes. Translation workflows can combine AI translation, professional translation, post-editing, linguistic review, terminology controls, translation memory, quality assurance, and approval based on the content and use case.
Review Workflow OptionsApplications can retrieve job status and use signed webhook events for processing updates, review milestones, exceptions, and completed delivery. Integrations should handle duplicate events safely and reconcile results by job identifier.
Review WebhooksUse structured errors, request identifiers, documented retry guidance, idempotency controls, and exponential backoff where supported. Do not retry validation or authentication failures without correcting the request.
Review Errors and OperationsDeveloper support can help with use-case design, solution architecture, workflow configuration, security review, integration testing, production readiness, and troubleshooting.
Contact Developer SupportStart Building with the Translation API
Follow the quickstart to authenticate, submit content, monitor the translation job, handle completion events, and retrieve multilingual results.