Storyblok
Login Contact Us Try for Free

  1. Translate a Story by AI

Management API

Translate a Story by AI

This endpoint returns the story content, translated by AI.

https://mapi.storyblok.com/v1/spaces/:space_id/stories/:story_id/ai_translate

This endpoint will not create or update any story. It will only return the content with the internationalized keys and values for the specific language. Please refer to Update a Story to apply the translation.

Path Parameters

  • :space_id

    required number

    Numeric ID of a space

  • :story_id

    required number

    Numeric id of story

Request Body Properties

  • lang

    string

    The official language code (e.g., en, de, fr) used for localization.

  • code

    string

    The custom language identifier defined in the Space Settings under Internationalization.

  • overwrite

    boolean

    Indicates whether the current value should replace the existing value for the specified language.

  • release_id

    number

    Release ID of the story.

Response Properties

  • story

    The Story Object

    A single story object, containing the translated fields in its content property.

    • id

      number

      Numeric id of the story

    • name

      string

      The complete name provided for the story

    • parent_id

      number

      ID of the parent folder

    • group_id

      string

      Group ID (UUID string), shared between stories defined as alternates

    • alternates

      object[]

      An array containing objects that provide basic data of the stories defined as alternates of the current story

      • id

        number

        The numeric ID

      • name

        string

        The complete name provided for the story

      • slug

        string

        The slug specific for the story

      • published

        boolean

        true if a story is currently published, even if it has unpublished changes.

      • full_slug

        string

        The full slug of the story, combining the parent folder(s) and the designated story slug

      • is_folder

        boolean

        true if the instance constitutes a folder

    • created_at

      string

      Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

    • deleted_at

      string

      Deleted date (Format: YYYY-mm-dd HH:MM)

    • sort_by_date

      string

      Date defined in the story's entry configuration (Format: YYYY-mm-dd)

    • tag_list

      string[]

      Array of tag names

    • updated_at

      string

      Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

    • published_at

      string

      Latest publishing date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

    • uuid

      string

      Generated UUID string

    • is_folder

      boolean

      true if the instance constitutes a folder

    • content

      object

      An object containing the field data associated with the specific story type's specific content structure. Also includes a component property with the story type's technical name.

    • published

      boolean

      true if a story is currently published, even if it has unpublished changes.

    • slug

      string

      The slug specific for the story

    • path

      string

      Value of the real path defined in the story's entry configuration (usually, this value is only required for Storyblok's Visual Editor)

    • full_slug

      string

      The full slug of the story, combining the parent folder(s) and the designated story slug

    • default_root

      string

      Component name which will be used as default content type for this folders entries

    • disable_fe_editor

      boolean

      Is side by side editor disabled for all entries in folder

    • parent

      object

      Essential parent information as object (resolved from parent_id)

    • is_startpage

      boolean

      true if the story is defined as root for the folder

    • unpublished_changes

      boolean

      Story has unpublished changes; saved but not published

    • meta_data

      object

      Object to store non-editable data that is exclusively maintained with the Management API

    • imported_at

      string

      Latest import date (Format: YYYY-mm-dd HH:MM)

    • preview_token

      object

      Preview token

      • token

        string

        The token passed to the editor as preview parameter to allow edit mode verification

      • timestamp

        string

        Timestamp passed to the editor as preview parameter to allow edit mode verification

    • pinned

      boolean

      To pin the story in the toolbar

    • breadcrumbs

      object[]

      Array of resolved subset of link objects (one per path segment / parent)

      • id

        number

        Story ID

      • name

        string

        The complete name provided for the story

      • parent_id

        number

        ID of the parent folder

      • disable_fe_editor

        boolean

        Is side by side editor disabled for all entries in folder

      • path

        string

        Value of the real path defined in the story's entry configuration (usually, this value is only required for Storyblok's Visual Editor)

      • slug

        string

        The slug specific for the story

      • translated_slugs

        object[]

        Array of translated slug objects (if the app Translatable Slugs is installed)

    • first_published_at

      string

      First publishing date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

    • last_author

      object

      Last author

      • id

        number

        Last author user object numeric id

      • userid

        string

        Last author userid/username

      • friendly_name

        string

        Friendly name of last author

    • last_author_id

      number

      Id of the last Author

    • translated_slugs

      object[]

      Array of translated slug objects (if the app Translatable Slugs is installed)

      • story_id

        number

        ID of the story

      • lang

        string

        Language code of the current language (can be requested with the language API parameter)

      • slug

        string

        The slug specific for the story

      • name

        string

        The complete name provided for the story

      • published

        boolean

        true if a story is currently published, even if it has unpublished changes.

    • translated_slugs_attributes

      object[]

      Array of translated slug attributes objects (if the app Translatable Slugs is installed) to change translated slugs when creating or updating a story

      • id

        number

        The numeric ID

      • lang

        string

        Language code of the current language (can be requested with the language API parameter)

      • slug

        string

        The slug specific for the story

      • name

        string

        The complete name provided for the story

      • published

        boolean

        true if a story is currently published, even if it has unpublished changes.

    • localized_paths

      object[]

      An array of translated path objects

      • path

        string

        Value of the real path defined in the story's entry configuration (usually, this value is only required for Storyblok's Visual Editor)

      • name

        string

        The complete name provided for the story

      • lang

        string

        Language code of the current language (can be requested with the language API parameter)

      • published

        boolean

        true if a story is currently published, even if it has unpublished changes.

    • position

      number

      Numeric representation of the story's position in the folder

    • release_id

      number

      ID of the current release (can be requested with the from_release API parameter)

    • scheduled_dates

      string

      Scheduled publishing date (Format: YYYY-mm-dd HH:MM)

    • favourite_for_user_ids

      number[]

      Array of user IDs who have added the story in their favorites

Request 
curl "https://mapi.storyblok.com/v1/spaces/606/stories/536503907/ai_translate" \ 
  -X PUT \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{ \"lang\": \"fr\", \"code\": \"fr\", \"release_id\": 0, \"overwrite\": true }"
Request 
// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.put('cdn/spaces/606/stories/536503907/ai_translate', { "lang": "fr", "code": "fr", "release_id": 0, "overwrite": true })
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })
Request 
$client = new \Storyblok\Client('YOUR_STORYBLOK_SPACE_ACCESS_TOKEN');

$payload = [ "lang" =>  "fr", "code" =>  "fr", "release_id" =>  0, "overwrite" =>  true ];

$client->put('/spaces/606/stories/536503907/ai_translate', $payload)->getBody();
Request 
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

payload = { "lang" =>  "fr", "code" =>  "fr", "release_id" =>  0, "overwrite" =>  true }

client.put('/spaces/606/stories/536503907/ai_translate', payload)
Request 
HttpResponse<String> response = Unirest.put("https://mapi.storyblok.com/v1/spaces/606/stories/536503907/ai_translate")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body("{ \"lang\": \"fr\", \"code\": \"fr\", \"release_id\": 0, \"overwrite\": true }")
  .asString();
Request 
var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/stories/536503907/ai_translate");
var request = new RestRequest(Method.PUT);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{ \"lang\": \"fr\", \"code\": \"fr\", \"release_id\": 0, \"overwrite\": true }", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Request 
import Foundation

let headers = [
  "Content-Type": "application/json",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let postData = NSData(data: "{ \"lang\": \"fr\", \"code\": \"fr\", \"release_id\": 0, \"overwrite\": true }".data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/stories/536503907/ai_translate")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
Request 
import requests

url = "https://mapi.storyblok.com/v1/spaces/606/stories/536503907/ai_translate"

querystring = {}

payload = "{ \"lang\": \"fr\", \"code\": \"fr\", \"release_id\": 0, \"overwrite\": true }"
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("PUT", url, data=payload, headers=headers, params=querystring)

print(response.text)

You will receive a single story object, containing the translated fields in its content property.

🍪 Cookie Notice

We use cookies to learn how you interact with our content, and show you relevant content and ads based on your browsing history. You can adjust your settings below. Here's our policy.

Manage your preferences