Phrase::ScreenshotsApi

All URIs are relative to https://api.phrase.com/v2

Method	HTTP request	Description
screenshot_create	POST /projects/{project_id}/screenshots	Create a screenshot
screenshot_delete	DELETE /projects/{project_id}/screenshots/{id}	Delete a screenshot
screenshot_show	GET /projects/{project_id}/screenshots/{id}	Get a single screenshot
screenshot_update	PATCH /projects/{project_id}/screenshots/{id}	Update a screenshot
screenshots_list	GET /projects/{project_id}/screenshots	List screenshots

screenshot_create

Screenshot screenshot_create(project_id, filename, opts)

Create a screenshot

Creates a screenshot in a project to provide visual context for in-context translation. Attach translation keys to regions of the uploaded image so translators can see where each string appears in your UI. This endpoint accepts a multipart/form-data request with a binary file upload, unlike most Phrase API endpoints that use JSON. Use a multipart form client or the -F flag in curl rather than a JSON body. The screenshot name must be unique within the project (case-insensitive). When name is omitted, it is derived from the uploaded filename. The account must have the Screenshots feature enabled; requests to projects on accounts without it return 403. Creating a screenshot requires a token with the write scope and manage access to the project.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::ScreenshotsApi.new
project_id = 'project_id_example' # String | Project ID
filename = File.new('/path/to/some/file') # File | Image file to upload. Accepted formats are JPEG (jpg/jpeg), GIF, and PNG. Maximum file size is 10 MB. Submitting an unsupported format or a file exceeding the size limit returns 422.
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  branch: 'branch_example', # String | specify the branch to use
  name: 'name_example', # String | Display name for the screenshot. Must be unique within the project (case-insensitive). When omitted, the name is derived from the uploaded filename.
  description: 'description_example' # String | Optional free-text description of the screenshot.
}

begin
  #Create a screenshot
  result = api_instance.screenshot_create(project_id, filename, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling ScreenshotsApi->screenshot_create: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
filename	File	Image file to upload. Accepted formats are JPEG (jpg/jpeg), GIF, and PNG. Maximum file size is 10 MB. Submitting an unsupported format or a file exceeding the size limit returns 422.
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
branch	String	specify the branch to use	[optional]
name	String	Display name for the screenshot. Must be unique within the project (case-insensitive). When omitted, the name is derived from the uploaded filename.	[optional]
description	String	Optional free-text description of the screenshot.	[optional]

Return type

Response<(Screenshot)>

Authorization

Basic, Token

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

screenshot_delete

screenshot_delete(project_id, id, opts)

Delete a screenshot

Permanently removes a screenshot and all its associated markers from the project. Use this when you need to fully remove a screenshot that is no longer relevant — for example, after a UI redesign renders the captured screen obsolete. This is a hard delete: the screenshot record and every key-to-region marker linked to it are destroyed together and cannot be recovered.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::ScreenshotsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  branch: 'my-feature-branch' # String | specify the branch to use
}

begin
  #Delete a screenshot
  api_instance.screenshot_delete(project_id, id, opts)
rescue Phrase::ApiError => e
  puts "Exception when calling ScreenshotsApi->screenshot_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
branch	String	specify the branch to use	[optional]

Return type

Response<(nil (empty response body))>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

screenshot_show

Screenshot screenshot_show(project_id, id, opts)

Get a single screenshot

Returns a single screenshot belonging to the specified project. Use this to retrieve the screenshot's name, description, hosted image URL, and marker count after uploading, or before creating, updating, or inspecting its markers. The response is a synchronous, idempotent read — repeated calls return the same record without side effects. The Attachable Screenshots feature must be enabled on the account.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::ScreenshotsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  branch: 'my-feature-branch' # String | specify the branch to use
}

begin
  #Get a single screenshot
  result = api_instance.screenshot_show(project_id, id, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling ScreenshotsApi->screenshot_show: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
branch	String	specify the branch to use	[optional]

Return type

Response<(Screenshot)>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

screenshot_update

Screenshot screenshot_update(project_id, id, screenshot_update_parameters, opts)

Update a screenshot

Update an existing screenshot.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::ScreenshotsApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | ID
screenshot_update_parameters = Phrase::ScreenshotUpdateParameters.new # ScreenshotUpdateParameters | 
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Update a screenshot
  result = api_instance.screenshot_update(project_id, id, screenshot_update_parameters, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling ScreenshotsApi->screenshot_update: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	ID
screenshot_update_parameters	ScreenshotUpdateParameters
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Response<(Screenshot)>

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

screenshots_list

Array<Screenshot> screenshots_list(project_id, opts)

List screenshots

List all screenshots for the given project.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::ScreenshotsApi.new
project_id = 'project_id_example' # String | Project ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  page: 1, # Integer | Page number
  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
  branch: 'my-feature-branch', # String | specify the branch to use
  key_id: 'abcd1234cdef1234abcd1234cdef1234' # String | filter by key
}

begin
  #List screenshots
  result = api_instance.screenshots_list(project_id, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling ScreenshotsApi->screenshots_list: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
page	Integer	Page number	[optional]
per_page	Integer	Limit on the number of objects to be returned, between 1 and 100. 25 by default	[optional]
branch	String	specify the branch to use	[optional]
key_id	String	filter by key	[optional]

Return type

Response<(Array<Screenshot>)>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

FilesExpand file tree

ScreenshotsApi.md

Latest commit

History

ScreenshotsApi.md

File metadata and controls

Phrase::ScreenshotsApi

screenshot_create

Example

Parameters

Return type

Authorization

HTTP request headers

screenshot_delete

Example

Parameters

Return type

Authorization

HTTP request headers

screenshot_show

Example

Parameters

Return type

Authorization

HTTP request headers

screenshot_update

Example

Parameters

Return type

Authorization

HTTP request headers

screenshots_list

Example

Parameters

Return type

Authorization

HTTP request headers