Skip to main content
POST
/
api
/
v1
/
evaluations
Create an evaluation
curl --request POST \
  --url https://app.autousers.ai/api/v1/evaluations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "teamId": "<string>",
  "description": "<string>",
  "type": "SxS",
  "status": "Draft",
  "shareAccess": "TEAM_ONLY",
  "sharePassword": "<string>",
  "shareRequireEmail": true,
  "shareRequireName": false,
  "shareAllowAnon": false,
  "shareExpiry": "<string>",
  "allowMultipleRatings": false,
  "useProxy": true,
  "proxyRegion": "<string>",
  "designUrls": [],
  "comparisonPairs": [],
  "selectedDimensionIds": [],
  "customDimensions": [],
  "selectedAutousers": [],
  "evaluationMethod": "manual",
  "instructions": "<string>",
  "scenario": "<string>",
  "skipPreQualification": false,
  "hideSlider": false,
  "hideOpenTextQuestions": false,
  "defaultLayout": "side",
  "ratingFlow": "combined",
  "dryRun": false
}
'
{
  "id": "<string>",
  "teamId": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "links": {
    "preview": "<string>",
    "review": "<string>",
    "edit": "<string>",
    "results": "<string>",
    "share": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Client-generated idempotency key (≤255 chars). Replays the cached response when the same (team, key) pair sees an identical request body within 24h; returns 409 idempotency_key_reused if the body differs. Recommended for every billable POST.

Maximum string length: 255
​
Autousers-Version
string

Date-pinned API version (e.g. 2026-05-04). Omit to receive the latest stable version. Behaves like Stripe's Stripe-Version — pinning a version freezes payload shapes against breaking changes during the 12-month sunset window.

Body

application/json
​
name
string
required
Required string length: 1 - 200
​
teamId
string<cuid>
​
description
string
Maximum string length: 2000
​
type
enum<string>
default:SxS
Available options:
SSE,
SxS
​
status
enum<string>
default:Draft
Available options:
Draft,
Running,
Ended,
Archived
​
shareAccess
enum<string>
default:TEAM_ONLY
Available options:
TEAM_ONLY,
AUTOUSERS_LINK,
ANYONE_WITH_LINK,
PASSWORD_PROTECTED
​
sharePassword
string
Minimum string length: 1
​
shareRequireEmail
boolean
default:true
​
shareRequireName
boolean
default:false
​
shareAllowAnon
boolean
default:false
​
shareExpiry
string | null
​
allowMultipleRatings
boolean
default:false
​
browserEngine
enum<string> | null
Available options:
CHROME,
CAMOUFOX
​
useProxy
boolean | null
​
proxyRegion
string | null
Minimum string length: 1
​
modelId
enum<string> | null
Available options:
gemini-3-flash-preview,
gemini-2.5-computer-use-preview-10-2025
​
designUrls
object[]
​
comparisonPairs
object[]
​
selectedDimensionIds
string[]
Minimum string length: 1
​
customDimensions
object[]
​
selectedAutousers
object[]
​
evaluationMethod
enum<string>
default:manual
Available options:
manual,
ai,
both
​
instructions
string
Maximum string length: 8000
​
scenario
string
Maximum string length: 8000
​
skipPreQualification
boolean
default:false
​
hideSlider
boolean
default:false
​
hideOpenTextQuestions
boolean
default:false
​
defaultLayout
enum<string>
default:side
Available options:
side,
stacked
​
ratingFlow
enum<string>
default:combined
Available options:
stepped,
combined
​
dryRun
boolean
default:false

Response

Created

​
id
string
required
​
teamId
string
required
​
name
string
required
​
type
enum<string>
required
Available options:
SSE,
SxS
​
status
enum<string>
required
Available options:
Draft,
Running,
Ended,
Archived
​
shareAccess
enum<string>
required
Available options:
TEAM_ONLY,
AUTOUSERS_LINK,
ANYONE_WITH_LINK,
PASSWORD_PROTECTED
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
description
string | null
​
links
object
​
{key}
any