Tricentis

Tricentis V2 Screen API

Screen V2 APIs

GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /sessions/{sessionId}/screens List a session's screens · Get all screens of session #
Ask an LLM
“Which screens were captured during an exploratory session?”
“Can I list every screenshot step of a session?”
Tell an agent
List the screens of session {session}.
Show all captured screens in session {session}.
POST /sessions/{sessionId}/screens Add a screen to a session · Create screen #
Ask an LLM
“How do I add a new captured screen to a session?”
“Can I add annotations when creating a screen?”
Tell an agent
Add screen {title} to session {session}.
Create a screen in session {session} with annotations {annotations}.
PUT /sessions/{sessionId}/screens Update several screens at once · Update multiple screens #
Ask an LLM
“Can I update many captured screens of a session in one request?”
“Is there a bulk edit for session screens?”
Tell an agent
Update multiple screens in session {session}.
Bulk edit the captured screens of session {session}.
GET /sessions/{sessionId}/screens/{screenId} Get a session screen · Get screen #
Ask an LLM
“Can I read the details of one captured screen?”
“What title and timestamp does a given screen have?”
Tell an agent
Get screen {screen} of session {session}.
Show the details of screen {screen} in session {session}.
PUT /sessions/{sessionId}/screens/{screenId} Update a session screen · Update screen #
Ask an LLM
“How do I rename or annotate one captured screen?”
“Can I reorder a single screen within a session?”
Tell an agent
Rename screen {screen} of session {session} to {title}.
Set annotations {annotations} on screen {screen} in session {session}.
DELETE /sessions/{sessionId}/screens/{screenId} Delete a session screen · Delete screen #
Ask an LLM
“How do I remove a captured screen from a session?”
“Can I delete one screen by id?”
Tell an agent destructive · confirm first
Delete screen {screen} from session {session}.
Remove captured screen {screen} in session {session}.
GET /sessions/{sessionId}/screens/{screenId}/images Get a screen's image · Get screen image #
Ask an LLM
“Can I download the full-size image of a captured screen?”
“Where is the screenshot image for one screen?”
Tell an agent
Get the image of screen {screen} in session {session}.
Download the full screenshot for screen {screen} of session {session}.
POST /sessions/{sessionId}/screens/{screenId}/images Upload a screen's image · Upload screen image #
Ask an LLM
“How do I upload the screenshot for a captured screen?”
“Can I replace the image data of a screen?”
Tell an agent
Upload image {file} for screen {screen} in session {session}.
Attach screenshot {file} to screen {screen}.
GET /sessions/{sessionId}/screens/{screenId}/image-url Get a link to a screen's image · Get screen image url #
Ask an LLM
“Can I get a URL to the full screenshot instead of the bytes?”
“What link should I use to show a screen image?”
Tell an agent
Return a link where screen {screen} of session {session} can be viewed at full size.
Give me a link to the full image of screen {screen}.
GET /sessions/{sessionId}/screens/{screenId}/thumbnail Get a screen's thumbnail · Get screen thumbnail #
Ask an LLM
“Can I download a small thumbnail of a captured screen?”
“Is there a preview-size image for each screen?”
Tell an agent
Get the thumbnail of screen {screen} in session {session}.
Download the preview thumbnail for screen {screen}.
GET /sessions/{sessionId}/screens/{screenId}/thumbnail-url Get a link to a screen's thumbnail · Get screen thumbnail url #
Ask an LLM
“Can I get a URL for a screen's thumbnail rather than the file?”
“What link shows the preview thumbnail of a screen?”
Tell an agent
Return a preview link for screen {screen} in session {session}.
Give me a link to the thumbnail preview of screen {screen}.

Documentation

📖
Documentation
https://docs.tricentis.com/qtest-saas/content/apis/overview/qtest_api_specification.htm
📖
APIReference
https://api.qasymphony.com/
📖
Documentation
https://docs.tricentis.com/qtest-saas/content/apis/data_export/use_data_export_api.htm
📖
APIReference
https://neoload-api.saas.neotys.com/explore/
📖
APIReference
https://api.ttm4j.tricentis.com/
📖
Documentation
https://docs.tricentis.com/ttm-for-jira/content/developer/api_overview.htm

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/openapi/tricentis-v2-screen-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/asyncapi/tricentis-qtest-webhooks.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/data-model/tricentis-data-model.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/tricentis/refs/heads/main/mcp/tricentis-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/tricentis:tricentis-v2-screen-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tricentis-v2-screen-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: qTest Explorer | Sessions V2 Screen API
  version: 1.0.0
  description: These APIs are for internal reference by Tricentis development team only. They are not intended to be used publicly by any qTest or non-qTest users and so there is no support provided by Tricentis at any level. If you want to access these APIs, please send a support ticket to support@tricentis.com.
servers:
- url: https://session-js.qtestnet.com/
tags:
- name: v2-screen
  description: Screen V2 APIs
paths:
  /sessions/{sessionId}/screens:
    get:
      tags:
      - v2-screen
      summary: Get all screens of session
      parameters:
      - name: sessionId
        in: path
        description: session's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: screens
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    $ref: '#/components/schemas/Links'
                  total:
                    type: integer
                  screens:
                    type: array
                    items:
                      $ref: '#/components/schemas/Screen'
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
        500:
          description: Server error
      security:
      - v2_auth: []
      x-swagger-router-controller: api.screen
      operationId: getSessionsBySessionIdScreens
      x-operation-id-source: derived
    post:
      tags:
      - v2-screen
      summary: Create screen
      parameters:
      - name: sessionId
        in: path
        description: session's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        201:
          description: Ok
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
        500:
          description: Server error
      security:
      - v2_auth: []
      x-swagger-router-controller: api.screen
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: '#/components/schemas/CreateScreen'
        description: Screen need to be created
        required: true
      operationId: postSessionsBySessionIdScreens
      x-operation-id-source: derived
    put:
      tags:
      - v2-screen
      summary: Update multiple screens
      parameters:
      - name: sessionId
        in: path
        description: session's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Ok
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
        500:
          description: Server error
      security:
      - v2_auth: []
      x-swagger-router-controller: api.screen
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateScreen'
        description: Screens need to be updated
        required: true
      operationId: putSessionsBySessionIdScreens
      x-operation-id-source: derived
  /sessions/{sessionId}/screens/{screenId}:
    get:
      tags:
      - v2-screen
      summary: Get screen
      parameters:
      - name: sessionId
        in: path
        description: session's id
        required: true
        schema:
          type: integer
          format: int64
      - name: screenId
        in: path
        description: screen's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: screen
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Screen'
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
        500:
          description: Server error
      security:
      - v2_auth: []
      x-swagger-router-controller: api.screen
      operationId: getSessionsBySessionIdScreensByScreenId
      x-operation-id-source: derived
    put:
      tags:
      - v2-screen
      summary: Update screen
      parameters:
      - name: sessionId
        in: path
        description: session's id
        required: true
        schema:
          type: integer
          format: int64
      - name: screenId
        in: path
        description: screen's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Ok
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
        500:
          description: Server error
      security:
      - v2_auth: []
      x-swagger-router-controller: api.screen
      requestBody:
        content:
          application/json:
            schema:
              type: object
              $ref: '#/components/schemas/UpdateScreen'
        description: Screen need to be updated
        required: true
      operationId: putSessionsBySessionIdScreensByScreenId
      x-operation-id-source: derived
    delete:
      tags:
      - v2-screen
      summary: Delete screen
      parameters:
      - name: sessionId
        in: path
        description: session's id
        required: true
        schema:
          type: integer
          format: int64
      - name: screenId
        in: path
        description: screen's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Ok
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
        500:
          description: Server error
      security:
      - v2_auth: []
      x-swagger-router-controller: api.screen
      operationId: deleteSessionsBySessionIdScreensByScreenId
      x-operation-id-source: derived
  /sessions/{sessionId}/screens/{screenId}/images:
    get:
      tags:
      - v2-screen
      summary: Get screen image
      parameters:
      - name: sessionId
        in: path
        description: session's id
        required: true
        schema:
          type: integer
          format: int64
      - name: screenId
        in: path
        description: screen's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: screen image
          content:
            application/json:
              schema:
                type: string
                format: binary
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
        500:
          description: Server error
      security:
      - v2_auth: []
      x-swagger-router-controller: api.screen
      operationId: getSessionsBySessionIdScreensByScreenIdImages
      x-operation-id-source: derived
    post:
      tags:
      - v2-screen
      summary: Upload screen image
      parameters:
      - name: sessionId
        in: path
        description: session's id
        required: true
        schema:
          type: integer
          format: int64
      - name: screenId
        in: path
        description: screen's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: screen image
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
        500:
          description: Server error
      security:
      - v2_auth: []
      x-swagger-router-controller: api.screen
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: image data
                  format: binary
              required:
              - file
      operationId: postSessionsBySessionIdScreensByScreenIdImages
      x-operation-id-source: derived
  /sessions/{sessionId}/screens/{screenId}/image-url:
    get:
      tags:
      - v2-screen
      summary: Get screen image url
      parameters:
      - name: sessionId
        in: path
        description: session's id
        required: true
        schema:
          type: integer
          format: int64
      - name: screenId
        in: path
        description: screen's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: screen image url
          content:
            application/json:
              schema:
                type: string
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
        500:
          description: Server error
      security:
      - v2_auth: []
      x-swagger-router-controller: api.screen
      operationId: getSessionsBySessionIdScreensByScreenIdImageUrl
      x-operation-id-source: derived
  /sessions/{sessionId}/screens/{screenId}/thumbnail:
    get:
      tags:
      - v2-screen
      summary: Get screen thumbnail
      parameters:
      - name: sessionId
        in: path
        description: session's id
        required: true
        schema:
          type: integer
          format: int64
      - name: screenId
        in: path
        description: screen's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: screen thumbnail
          content:
            application/json:
              schema:
                type: string
                format: binary
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
        500:
          description: Server error
      security:
      - v2_auth: []
      x-swagger-router-controller: api.screen
      operationId: getSessionsBySessionIdScreensByScreenIdThumbnail
      x-operation-id-source: derived
  /sessions/{sessionId}/screens/{screenId}/thumbnail-url:
    get:
      tags:
      - v2-screen
      summary: Get screen thumbnail url
      parameters:
      - name: sessionId
        in: path
        description: session's id
        required: true
        schema:
          type: integer
          format: int64
      - name: screenId
        in: path
        description: screen's id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: screen thumbnail url
          content:
            application/json:
              schema:
                type: string
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
        500:
          description: Server error
      security:
      - v2_auth: []
      x-swagger-router-controller: api.screen
      operationId: getSessionsBySessionIdScreensByScreenIdThumbnailUrl
      x-operation-id-source: derived
components:
  schemas:
    TimeType:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        color:
          type: string
    ActionMetadata:
      type: object
      properties:
        element_type:
          type: string
        id:
          type: string
        name:
          type: string
        css_selector:
          type: string
        tag_name:
          type: string
        xpath:
          type: array
          items:
            type: string
        value:
          type: string
        ctrl_type:
          type: integer
        action_type:
          type: string
        details:
          type: object
    Point:
      type: object
      properties:
        x:
          type: number
          format: double
        y:
          type: number
          format: double
    Annotation:
      type: object
      properties:
        annotation_type:
          type: string
          enum:
          - Action
          - Rectangle
          - Ellipse
          - Callout
          - Pencil
          - Arrow
          - Blackout
          - TextBox
        type:
          type: string
          enum:
          - square
          - round
          - oval
          - cloud
          - line1
          - line2
          - line3
          - line1AccentBar
          - line2AccentBar
          - line3AccentBar
        order_number:
          type: integer
        desc:
          type: string
        meta_data:
          $ref: '#/components/schemas/ActionMetadata'
        left:
          type: number
          format: double
        top:
          type: number
          format: double
        width:
          type: number
          format: double
        height:
          type: number
          format: double
        hotspotx:
          type: number
          format: double
        hotspoty:
          type: number
          format: double
        anchor_point:
          $ref: '#/components/schemas/Point'
        background_color:
          type: string
        border_color:
          type: string
        border_size:
          type: integer
        content:
          type: string
        font_name:
          type: string
        font_size:
          type: integer
        text_color:
          type: string
        points:
          type: array
          items:
            $ref: '#/components/schemas/Point'
        start_point:
          $ref: '#/components/schemas/Point'
        end_point:
          $ref: '#/components/schemas/Point'
        zindex:
          type: integer
        drop_shadow:
          type: boolean
        timestamp:
          type: string
          description: 'timestamp, Ex: 2018-01-16T04:46:30+07'
        is_visible_on_screen:
          type: boolean
    Screen:
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Links'
        id:
          type: string
        ext_screen_id:
          type: string
        order:
          type: string
        capture_mode:
          type: string
          enum:
          - Desktop
          - Application
          - Form
        screenshot_filename:
          type: string
        thumbnail_filename:
          type: string
        title:
          type: string
        browser_url:
          type: string
        is_deleted:
          type: boolean
        time_type:
          $ref: '#/components/schemas/TimeType'
        finished_timestamp:
          type: string
          description: 'finished timestamp, Ex: 2018-01-15T21:46:30.000Z'
        timestamp:
          type: string
          description: 'timestamp, Ex: 2018-01-15T21:46:30.000Z'
        created_date:
          type: string
          description: 'created date, Ex: 2018-01-16T09:46:30.265Z'
        modified_date:
          type: string
          description: 'modified date, Ex: 2018-04-05T15:30:09.865Z'
        original_title:
          type: string
        app_height:
          type: number
          format: double
        app_left:
          type: number
          format: double
        app_top:
          type: number
          format: double
        app_width:
          type: number
          format: double
        height:
          type: number
          format: double
        left:
          type: number
          format: double
        top:
          type: number
          format: double
        width:
          type: number
          format: double
        screen_height:
          type: number
          format: double
        screen_width:
          type: number
          format: double
        annotations:
          type: array
          items:
            $ref: '#/components/schemas/Annotation'
        image_url:
          type: string
        thumbnail:
          type: string
        direct_image_url:
          type: string
        direct_thumbnail:
          type: string
    Links:
      type: array
      items:
        $ref: '#/components/schemas/Link'
    Link:
      type: object
      properties:
        rel:
          type: string
        href:
          type: string
    UpdateScreen:
      type: object
      properties:
        id:
          type: string
        order:
          type: integer
        capture_mode:
          type: string
          enum:
          - Desktop
          - Application
          - Form
        title:
          type: string
        time_type:
          $ref: '#/components/schemas/TimeType'
        timestamp:
          type: string
          description: 'timestamp, Ex: 2018-01-15T21:46:30.000Z'
        app_height:
          type: number
          format: double
        app_left:
          type: number
          format: double
        app_top:
          type: number
          format: double
        app_width:
          type: number
          format: double
        height:
          type: number
          format: double
        left:
          type: number
          format: double
        top:
          type: number
          format: double
        width:
          type: number
          format: double
        screen_height:
          type: number
          format: double
        screen_width:
          type: number
          format: double
        annotations:
          type: array
          items:
            $ref: '#/components/schemas/Annotation'
        is_deleted:
          type: boolean
    CreateScreen:
      type: object
      properties:
        id:
          type: string
        order:
          type: integer
        capture_mode:
          type: string
          enum:
          - Desktop
          - Application
          - Form
        title:
          type: string
        time_type:
          $ref: '#/components/schemas/TimeType'
        timestamp:
          type: string
          description: 'timestamp, Ex: 2018-01-15T21:46:30.000Z'
        app_height:
          type: number
          format: double
        app_left:
          type: number
          format: double
        app_top:
          type: number
          format: double
        app_width:
          type: number
          format: double
        height:
          type: number
          format: double
        left:
          type: number
          format: double
        top:
          type: number
          format: double
        width:
          type: number
          format: double
        screen_height:
          type: number
          format: double
        screen_width:
          type: number
          format: double
        annotations:
          type: array
          items:
            $ref: '#/components/schemas/Annotation'
        is_deleted:
          type: boolean
  securitySchemes:
    v2_auth:
      type: apiKey
      name: Authorization
      in: header
    v3_auth:
      type: apiKey
      name: Authorization
      in: header