Skip to main content
The ScreenScore AI REST API gives you programmatic access to everything on the platform: submit UI screens or ad creatives for scoring, organize work into projects, retrieve results, and listen for events via webhooks. Every request goes over HTTPS to a single versioned base URL, and every response comes back as JSON.

Base URL

All API endpoints share the following base URL:
https://api.screenscoreai.com/v1
The version identifier (v1) is part of the path. When a new major version is released, the old version remains available at its original path so your integrations keep working without changes.

HTTPS required

The API only accepts requests over HTTPS. Requests sent over plain HTTP will be rejected. Ensure your HTTP client follows redirects and validates TLS certificates.

Authentication

Every request must include an Authorization header with a valid API key. See Authentication for instructions on creating keys and adding the header to your requests.

Response format

All responses — including errors — return Content-Type: application/json. Successful responses return a top-level object containing the requested resource or list.

Rate limits

Rate limits apply per API key, per minute:
PlanRequests per minute
Free10
Pro60
Enterprise300
When you exceed your limit, the API returns 429 Too Many Requests. Wait until the next minute window before retrying.

Error format

All errors return a consistent JSON structure:
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key"
  }
}
The code field is a machine-readable string you can use for programmatic error handling. The message field provides a human-readable explanation.

Common error codes

HTTP statusCodeMeaning
401unauthorizedThe API key is missing or invalid.
403forbiddenThe API key does not have permission for this resource.
404not_foundThe requested resource does not exist.
429rate_limit_exceededYou have exceeded your plan’s rate limit.
500internal_errorAn unexpected error occurred on the ScreenScore AI side.