Skip to main content
GET
/
api
/
v1
/
styleguides
/
async
/
create-jobs
/
{jobId}
Get create job status
curl --request GET \
  --url https://eu.phrase.com/styleguide/api/v1/styleguides/async/create-jobs/{jobId} \
  --header 'Authorization: Bearer <token>'
{
  "jobId": "<string>",
  "result": {
    "id": "018e1234-5678-7890-abcd-ef1234567890",
    "name": "English Style Guide",
    "description": "Style guide for English content",
    "language": {
      "bcpCode": "en-GB",
      "description": "English (United Kingdom)",
      "language": "cs",
      "region": "gb",
      "script": "LATN"
    },
    "isDefault": false,
    "createdBy": {
      "id": "0015oCjtouINgRCDIvQtjo",
      "username": "john.doe",
      "fullName": "John Doe",
      "email": "john.doe@example.com",
      "avatarUrl": "https://example.com/avatars/john-doe.png"
    },
    "lastModifiedBy": {
      "id": "0015oCjtouINgRCDIvQtjo",
      "username": "john.doe",
      "fullName": "John Doe",
      "email": "john.doe@example.com",
      "avatarUrl": "https://example.com/avatars/john-doe.png"
    },
    "versions": [
      {
        "id": "018e1234-5678-7890-abcd-ef1234567890",
        "versionNumber": 1,
        "name": "English Style Guide v1",
        "description": "Initial version of the style guide",
        "changeNotes": "Updated grammar rules and added new terminology",
        "fileName": "StyleGuide.md",
        "fileSizeBytes": 1024,
        "fileType": "text/markdown",
        "createdAt": "2024-01-15T10:30:00Z",
        "lastModifiedAt": "2024-01-15T10:30:00Z",
        "lastModifiedBy": {
          "id": "0015oCjtouINgRCDIvQtjo",
          "username": "john.doe",
          "fullName": "John Doe",
          "email": "john.doe@example.com",
          "avatarUrl": "https://example.com/avatars/john-doe.png"
        }
      }
    ],
    "createdAt": "2024-01-15T10:30:00Z",
    "lastModifiedAt": "2024-01-15T10:30:00Z"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "detail": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.phrase.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

JWT from IDM (Authorization: Bearer )

Path Parameters

jobId
string
required

Response

Job status

jobId
string
status
enum<string>
Available options:
PROCESSING,
COMPLETED,
FAILED
result
object

Style Guide information

error
object