Services

A service represents the service in a job. For example, translation or revision.

The service object

Properties

  • idstring

    Unique identifier for the object.

  • namestring

    The name of the service.

  • disabledboolean

    True if the service is disabled.

  • pinnedboolean

    True if the entity is pinned.

service object

{
  "id": "6548c16d5136b418fd626e5f",
  "name": "Translation",
  "pinned": false,
  "disabled": false
}
GET/v2/account/services

List all services

This endpoint allows you to retrieve all the services.

Request

GET
/v2/account/services
curl -G https://api.lsp.expert/v2/account/services \
  -u {key}:

Response

[
  {
      "id": "6548c16d5136b418fd626e5f",
      "name": "Translation",
      "pinned": false,
      "disabled": false
  },
  {
    "id": "6548efee465457462ed5250b",
    "name": "Revision",
    "pinned": false,
    "disabled": false
  }
  // ...
]
POST/v2/account/services

Create a service

This endpoint allows you to add a new service.

Parameters

  • namestring Required

    The name of the service.

Request

POST
/v2/account/services
curl https://api.lsp.expert/v2/account/services \
  -u {key}: \
  -d name="Post-editing"

Response

{
  "id": "6694d3bb35f2e710ae4a30b6",
  "name": "Post-editing",
  "pinned": false,
  "disabled": false
}
PUT/v2/account/services/:id

Update a service

This endpoint allows you to perform an update on a service. Any parameters not provided will be left unchanged.

Parameters

  • namestring

    The name of the service.

  • disabledboolean

    True if the service is disabled.

  • pinnedboolean

    True if the entity is pinned.

Request

PUT
/v2/account/services/:id
curl -X PUT https://api.lsp.expert/v2/account/services/66e7f69da9d8b6741f4a441d \
  -u {key}: \
  -d pinned=true

Response

{
  "id": "6694d3bb35f2e710ae4a30b6",
  "name": "Post-editing",
  "pinned": true,
  "disabled": false
}
DELETE/v2/account/services/:id

Delete a service

This endpoint allows you to delete a service.

Request

DELETE
/v2/account/services/66e7f69da9d8b6741f4a441d
curl -X DELETE https://api.lsp.expert/v2/account/services/66e7f69da9d8b6741f4a441d \
  -u {key}: