> ## Documentation Index
> Fetch the complete documentation index at: https://docs.myunite.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a pre-test

> Returns one pre-test. result is present when status is completed, error when it is failed. The state you read here is the source of truth.

Requires the `pretests:read` scope.



## OpenAPI

````yaml /api-reference/openapi.json get /pretests/{id}
openapi: 3.1.0
info:
  title: Unite API
  version: 1.0.0
  description: >-
    Run ad pre-tests from your own systems: upload a creative, create a
    pre-test, and read its result and PDF report. Every request needs an API key
    sent as a Bearer token. Every response carries an X-Request-Id header.
servers:
  - url: https://myunite.ai/api/v1
security:
  - bearerAuth: []
tags:
  - name: Catalog
    description: What you can send when you create a pre-test.
  - name: Uploads
    description: Send creative files.
  - name: Pretests
    description: Create pre-tests and read their results.
  - name: Quota
    description: How many pre-tests you can still run.
  - name: Webhooks
    description: Manage the endpoints that are notified when a pre-test changes.
paths:
  /pretests/{id}:
    get:
      tags:
        - Pretests
      summary: Get a pre-test
      description: >-
        Returns one pre-test. result is present when status is completed, error
        when it is failed. The state you read here is the source of truth.


        Requires the `pretests:read` scope.
      operationId: getPretest
      parameters:
        - name: id
          in: path
          required: true
          description: Pre-test id.
          schema:
            type: string
      responses:
        '200':
          description: The pre-test.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pretest'
        '401':
          description: >-
            Error. Possible codes: invalid_api_key, api_key_revoked,
            api_key_expired.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Error. Possible codes: feature_not_enabled, key_owner_not_member,
            insufficient_scope.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 'Error. Possible codes: not_found.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Error. Possible codes: rate_limited.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            Retry-After:
              $ref: '#/components/headers/Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: 'Error. Possible codes: internal_error.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  headers:
    X-Request-Id:
      description: >-
        Identifier of this request. Quote it when you contact support. It is
        also in error.requestId.
      schema:
        type: string
    RateLimit-Limit:
      description: >-
        Requests allowed per minute for this key and bucket: 600 for reads, 60
        for writes. Sent on responses once the key is accepted. On 401 errors
        and on 403 errors raised while the key is checked they may be absent.
      schema:
        type: integer
    RateLimit-Remaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimit-Reset:
      description: Seconds until the oldest counted request leaves the window.
      schema:
        type: integer
    Retry-After:
      description: Seconds to wait before you try again.
      schema:
        type: integer
  schemas:
    Pretest:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
          const: pretest
        status:
          type: string
          enum:
            - queued
            - processing
            - completed
            - failed
          description: >-
            queued: accepted and waiting to start. processing: being analyzed.
            completed: result available. failed: see error.
        channel:
          type: string
          enum:
            - ooh
            - digital
            - email
        title:
          type: string
        locale:
          type: string
          description: Language of the result text (pt, en or es).
        createdAt:
          type: string
          description: ISO 8601 UTC.
        updatedAt:
          type: string
          description: ISO 8601 UTC.
        brand:
          anyOf:
            - type: object
              properties:
                id:
                  type: string
                name:
                  type: string
              required:
                - id
                - name
            - type: 'null'
        creative:
          type: object
          properties:
            type:
              type: string
              enum:
                - image
                - video
            thumbnailUrl:
              type:
                - string
                - 'null'
          required:
            - type
            - thumbnailUrl
        result:
          anyOf:
            - type: object
              properties:
                score:
                  description: Overall score from 0 to 10.
                  type:
                    - number
                    - 'null'
                recommendation:
                  anyOf:
                    - type: string
                      enum:
                        - launch
                        - optimize
                        - iterate
                    - type: 'null'
                  description: >-
                    Null only when the stored recommendation is not one of the
                    three codes.
                recommendationLabel:
                  description: Display text of the recommendation in the result language.
                  type:
                    - string
                    - 'null'
                conclusion:
                  type:
                    - string
                    - 'null'
                pillars:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    type:
                      - number
                      - 'null'
                  description: Score from 0 to 10 per pillar.
                findings:
                  type: array
                  items:
                    type: object
                    properties:
                      check:
                        type: string
                        description: Stable identifier of the check.
                      name:
                        type: string
                      category:
                        type: string
                      status:
                        type: string
                        enum:
                          - pass
                          - warn
                          - fail
                          - info
                          - pending
                      score:
                        type:
                          - number
                          - 'null'
                      summary:
                        type:
                          - string
                          - 'null'
                      optional:
                        type: boolean
                    required:
                      - check
                      - name
                      - category
                      - status
                      - score
                      - summary
                      - optional
                recommendations:
                  type: array
                  items:
                    type: object
                    properties:
                      title:
                        type: string
                      description:
                        type: string
                      priority:
                        type: string
                        enum:
                          - high
                          - medium
                          - low
                      category:
                        type:
                          - string
                          - 'null'
                    required:
                      - title
                      - description
                      - priority
                      - category
                maps:
                  type: object
                  properties:
                    heatmap:
                      anyOf:
                        - type: object
                          properties:
                            url:
                              type: string
                              description: Link to the image or video.
                            mediaType:
                              type: string
                              enum:
                                - image/jpeg
                                - video/mp4
                          required:
                            - url
                            - mediaType
                        - type: 'null'
                    contrast:
                      anyOf:
                        - type: object
                          properties:
                            url:
                              type: string
                              description: Link to the image or video.
                            mediaType:
                              type: string
                              enum:
                                - image/jpeg
                                - video/mp4
                          required:
                            - url
                            - mediaType
                        - type: 'null'
                    focus:
                      anyOf:
                        - type: object
                          properties:
                            url:
                              type: string
                              description: Link to the image or video.
                            mediaType:
                              type: string
                              enum:
                                - image/jpeg
                                - video/mp4
                          required:
                            - url
                            - mediaType
                        - type: 'null'
                  required:
                    - heatmap
                    - contrast
                    - focus
              required:
                - score
                - recommendation
                - recommendationLabel
                - conclusion
                - pillars
                - findings
                - recommendations
                - maps
            - type: 'null'
          description: Present only when status is completed.
        report:
          type: object
          properties:
            status:
              type: string
              enum:
                - pending
                - generating
                - ready
                - failed
                - unavailable
              description: >-
                State of the PDF report. pending until it is generated: for OOH
                and digital it is usually generated automatically after the
                analysis completes, for email only when you request it with GET
                /pretests/{id}/report. unavailable when it finished without a
                download link.
            url:
              description: Download link, present when status is ready.
              type:
                - string
                - 'null'
          required:
            - status
            - url
        error:
          anyOf:
            - type: object
              properties:
                code:
                  type: string
                  enum:
                    - video_too_long
                    - quota_exhausted
                    - dispatch_failed
                    - processing_failed
                message:
                  type: string
              required:
                - code
                - message
            - type: 'null'
          description: Present only when status is failed.
        metadata:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: string
          description: The key-value pairs sent on creation. Empty when none were sent.
      required:
        - id
        - object
        - status
        - channel
        - title
        - locale
        - createdAt
        - updatedAt
        - brand
        - creative
        - result
        - report
        - error
        - metadata
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_api_key
                - api_key_revoked
                - api_key_expired
                - insufficient_scope
                - feature_not_enabled
                - key_owner_not_member
                - rate_limited
                - concurrency_limit
                - invalid_request
                - idempotency_key_required
                - idempotency_conflict
                - idempotency_key_retired
                - upload_not_found
                - upload_invalid
                - file_too_large
                - video_too_long
                - invalid_ooh_format
                - invalid_placement
                - brand_not_found
                - quota_exhausted
                - not_found
                - report_not_ready
                - webhook_url_rejected
                - webhook_endpoint_limit
                - internal_error
              description: >-
                Stable machine-readable code. Branch on this, not on the
                message.
            message:
              type: string
              description: Human-readable explanation in English. Its wording can change.
            requestId:
              type: string
              description: >-
                Same value as the X-Request-Id response header. Quote it when
                you contact support.
            docUrl:
              type: string
              description: Page that explains this code.
            param:
              description: >-
                The field, query parameter or header the error refers to, when
                there is one.
              type: string
          required:
            - code
            - message
            - requestId
            - docUrl
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key, sent as `Authorization: Bearer unite_live_...`. Create keys in
        the workspace settings.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.