> ## Documentation Index > Fetch the complete documentation index at: https://docs.synack.com/llms.txt > Use this file to discover all available pages before exploring further. # Create an assessment (V1) > Create an assessment in one of the assessment groups of the organization of the caller. Assets are referenced by the uid the asset API returns for them, and are in scope unless marked out of scope. Tags are created when no tag of that name exists yet. Requires the permission to create assessments in the group, and assessment creation enabled for the organization. ## OpenAPI ````yaml /monolith-v1-openapi.yaml post /v1/assessments openapi: 3.0.3 info: title: Synack API version: 2.0.0 description: > Comprehensive API for Synack's security testing platform, providing endpoints for managing assessments, vulnerabilities, users, and security testing operations. contact: name: Synack Engineering email: engineering@synack.com license: name: Proprietary servers: - url: https://api.synack.com description: Commercial - V1 API - url: https://api.synack.us description: FedRAMP (Medium) - V1 API security: - BearerAuth: [] - BasicAuth: [] - ApiKeyAuth: [] tags: - name: Assessments description: Operations related to security assessments - name: Tests description: Operations related to security tests - name: Test Plans description: Operations related to test plans - name: Vulnerabilities description: Operations related to security vulnerabilities - name: Suspected Vulnerabilities description: Operations related to suspected vulnerabilities - name: Comments description: Operations related to comments - name: Patch Verifications description: Operations related to patch verifications - name: Users description: Operations related to users - name: Assessment Groups description: Operations related to assessment groups - name: Tags description: Operations related to tags - name: Vulnerability Statuses description: Operations related to vulnerability statuses - name: Listings description: Operations related to listings - name: Login IP Allowlist description: Operations related to the organization's login IP allowlist paths: /v1/assessments: post: tags: - Assessments summary: Create an assessment (V1) description: > Create an assessment in one of the assessment groups of the organization of the caller. Assets are referenced by the uid the asset API returns for them, and are in scope unless marked out of scope. Tags are created when no tag of that name exists yet. Requires the permission to create assessments in the group, and assessment creation enabled for the organization. operationId: createAssessment requestBody: required: true content: application/json: schema: type: object required: - name - category - assessment_group_id - assets properties: name: type: string minLength: 5 maxLength: 100 description: Name of the assessment example: Customer portal category: type: string enum: - Web Application - Host - API description: >- Type of the assessment. API assessments need API testing enabled for the organization. assessment_group_id: type: integer description: ID of the assessment group to create the assessment in example: 123 assets: type: array minItems: 1 description: Assets to test items: type: object required: - uid properties: uid: type: string description: UID of the asset, as returned by the asset API example: asset-uid-123 scope: type: string enum: - in - out default: in description: Whether the asset is in or out of scope description: type: string description: Description of the assessment authentication_self_registration_enabled: type: boolean default: false description: >- Whether researchers may register their own accounts for authenticated testing tag_names: type: array items: type: string description: Names of the tags to put on the assessment example: - production responses: '201': description: The created assessment content: application/json: schema: $ref: '#/components/schemas/Assessment' '400': description: A parameter is missing or invalid content: application/json: schema: $ref: '#/components/schemas/Errors' '403': description: >- The user is not allowed to create assessments in the assessment group '404': description: Assessment creation is not enabled for the organization '422': description: >- The assessment could not be created, for example because its assets could not be assigned content: application/json: schema: $ref: '#/components/schemas/Errors' components: schemas: Assessment: type: object required: - id - name - codename - category - active - created_at - tag_ids - authentication_self_registration_enabled properties: id: type: string description: ID of the assessment example: foobar-123 name: type: string example: Customer portal codename: type: string example: ACMEALPHA description: type: string nullable: true details: type: string nullable: true category: type: string description: Type of the assessment example: Web Application active: type: boolean description: Whether the assessment is open for testing rules: type: string nullable: true description: Rules of engagement of the assessment updates: type: array description: Updates posted to the researchers items: type: object properties: message: type: string created_at: type: integer description: Unix timestamp of the update created_at: type: string format: date-time tag_ids: type: array items: type: integer authentication_self_registration_enabled: type: boolean description: >- Whether researchers may register their own accounts for authenticated testing Errors: type: object required: - errors properties: errors: type: array items: $ref: '#/components/schemas/Error' Error: type: object required: - key - title - status properties: key: type: string description: Machine-readable kind of the error example: invalid_parameter title: type: string example: Invalid parameter status: type: integer description: HTTP status of the response example: 400 detail: type: string description: What went wrong, naming the parameter for a validation error example: name is required securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT BasicAuth: type: http scheme: basic ApiKeyAuth: type: apiKey in: header name: X-Auth ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.