List the translatable strings in a file

Extracts translatable strings from a source or resource file. The file type comes from the filename extension (JSX/TSX, Vue, Svelte, HTML, Markdown, JSON, PO, YAML, XLIFF, Android XML, iOS strings, ARB, properties, CSV). Metered as localization.extract.

POST/v1/localization/extract

Authorization

AuthorizationBearer token (JWT) · headerrequired

Bearer API key issued for your account. Send Authorization: Bearer <key>.

Request body

requiredapplication/json

filenamestringrequired

contentstringrequired

Up to 1 MiB.

Responses

200

Extracted strings

filenamestringrequired

countintegerrequired

unitsobject[]required

Show properties

Array of object

keystring | null

textstringrequired

contextstring | null

400

Bad request

string

401

Missing or invalid bearer token

string

403

Billing or plan entitlement blocked the request

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

filenamestring*contentstring*Up to 1 MiB.

Request

curl -X POST 'https://api.webfold.ai/v1/localization/extract' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "filename": "locales/en.json",
  "content": "string"
}'

import requests

response = requests.post(
    "https://api.webfold.ai/v1/localization/extract",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"filename\": \"locales/en.json\",\n  \"content\": \"string\"\n}",
)

const response = await fetch("https://api.webfold.ai/v1/localization/extract", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"filename\": \"locales/en.json\",\n  \"content\": \"string\"\n}"
});

Response

{
  "filename": "string",
  "count": 0,
  "units": [
    {
      "key": "string",
      "text": "string",
      "context": "string"
    }
  ]
}

"string"

"string"

"string"