Create a project
Create a new project in an account you administer. The authenticated personal access token must be scoped to the target account, and the acting user must be an administrator of it. Use it when the user wants to start visual testing for a new app or repository.
Create a new project in an account you administer. The authenticated personal access token must be scoped to the target account, and the acting user must be an administrator of it. Use it when the user wants to start visual testing for a new app or repository.
Authenticate as a user with a personal access token.
Send it as a bearer token in the Authorization header:
Authorization: Bearer <personal-access-token>Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/projects" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "accountSlug": "string" }'{ "id": "string", "account": { "id": "string", "slug": "string" }, "name": "string", "defaultBaseBranch": "string", "hasRemoteContentAccess": true, "autoApprovedBranchGlob": "string", "deploymentProductionBranchGlob": "string", "private": true, "summaryCheck": "always", "prCommentEnabled": true, "githubActionsOidcEnabled": true, "tokenlessAuthEnabled": true, "deploymentEnabled": true, "deploymentAuth": "public", "defaultUserLevel": "admin", "ignoreConfig": { "enabled": true, "autoIgnore": { "changes": 1 } }}