thefaqapp
API Reference

Translations

Manage translations

Manage translations

List question translations

GET
/api/v1/{organizationSlug}/questions/{slug}/translations

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string

Question slug

Response Body

application/json

curl -X GET "https://app.thefaq.app/api/v1/string/questions/string/translations"
{
  "data": [
    {
      "id": "string",
      "language": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
Empty
Empty

Create question translation

POST
/api/v1/{organizationSlug}/questions/{slug}/translations

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://app.thefaq.app/api/v1/string/questions/string/translations" \  -H "Content-Type: application/json" \  -d '{    "language": "es",    "question": "string",    "answer": "string",    "slug": "string"  }'
{
  "data": {
    "id": "string",
    "language": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty
Empty

Get question translation

GET
/api/v1/{organizationSlug}/questions/{slug}/translations/{language}

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string
language*string

Response Body

application/json

curl -X GET "https://app.thefaq.app/api/v1/string/questions/string/translations/es"
{
  "data": {
    "id": "string",
    "language": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty

Delete question translation

DELETE
/api/v1/{organizationSlug}/questions/{slug}/translations/{language}

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string
language*string

Response Body

application/json

curl -X DELETE "https://app.thefaq.app/api/v1/string/questions/string/translations/string"
{
  "data": {
    "deleted": true
  }
}
Empty
Empty

Update question translation

PUT
/api/v1/{organizationSlug}/questions/{slug}/translations/{language}

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string
language*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://app.thefaq.app/api/v1/string/questions/string/translations/string" \  -H "Content-Type: application/json" \  -d '{    "question": "string",    "answer": "string",    "slug": "string"  }'
{
  "data": {
    "id": "string",
    "language": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty
Empty

AI translate question

POST
/api/v1/{organizationSlug}/questions/{slug}/translations/ai-translate

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://app.thefaq.app/api/v1/string/questions/string/translations/ai-translate" \  -H "Content-Type: application/json" \  -d '{    "targetLanguage": "fr"  }'
{
  "data": {
    "id": "string",
    "language": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty
Empty
Empty

List category translations

GET
/api/v1/{organizationSlug}/categories/{slug}/translations

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string

Category slug

Response Body

application/json

curl -X GET "https://app.thefaq.app/api/v1/string/categories/string/translations"
{
  "data": [
    {
      "id": "string",
      "language": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
Empty
Empty

Create category translation

POST
/api/v1/{organizationSlug}/categories/{slug}/translations

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://app.thefaq.app/api/v1/string/categories/string/translations" \  -H "Content-Type: application/json" \  -d '{    "language": "de",    "name": "string",    "slug": "string"  }'
{
  "data": {
    "id": "string",
    "language": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty
Empty

Get category translation

GET
/api/v1/{organizationSlug}/categories/{slug}/translations/{language}

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string
language*string

Response Body

application/json

curl -X GET "https://app.thefaq.app/api/v1/string/categories/string/translations/string"
{
  "data": {
    "id": "string",
    "language": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty

Delete category translation

DELETE
/api/v1/{organizationSlug}/categories/{slug}/translations/{language}

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string
language*string

Response Body

application/json

curl -X DELETE "https://app.thefaq.app/api/v1/string/categories/string/translations/string"
{
  "data": {
    "deleted": true
  }
}
Empty
Empty

Update category translation

PUT
/api/v1/{organizationSlug}/categories/{slug}/translations/{language}

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string
language*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://app.thefaq.app/api/v1/string/categories/string/translations/string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "slug": "string"  }'
{
  "data": {
    "id": "string",
    "language": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty
Empty

AI translate category

POST
/api/v1/{organizationSlug}/categories/{slug}/translations/ai-translate

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string
slug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://app.thefaq.app/api/v1/string/categories/string/translations/ai-translate" \  -H "Content-Type: application/json" \  -d '{    "targetLanguage": "ja"  }'
{
  "data": {
    "id": "string",
    "language": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty
Empty
Empty

Get translation completeness

GET
/api/v1/{organizationSlug}/translations/completeness

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string

Response Body

application/json

curl -X GET "https://app.thefaq.app/api/v1/string/translations/completeness"
{
  "data": {
    "languages": [
      {
        "language": "string",
        "questionsTranslated": 0,
        "questionsTotal": 0,
        "categoriesTranslated": 0,
        "categoriesTotal": 0,
        "completeness": 0
      }
    ]
  }
}
Empty

A P I Keys

Manage API keys

Webhooks

Manage webhooks