> ## Documentation Index > Fetch the complete documentation index at: https://evalgate.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create onboarding plan > Requires scopes: eval:read ## OpenAPI ````yaml /api-reference/openapi.json post /api/onboarding/setup/plan openapi: 3.1.0 info: title: EvalGate API version: 3.7.6 description: EvalGate API. See docs/api-contract.md for stability commitments. servers: - url: https://evalgate.com description: Production - url: http://localhost:3000 description: Local security: [] paths: /api/onboarding/setup/plan: post: tags: - onboarding summary: Create onboarding plan description: 'Requires scopes: eval:read' operationId: post_onboarding_setup_plan requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiOnboardingSetupPlanRequest' responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/PostApiOnboardingSetupPlanResponse200ApplicationJson '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' security: - bearerAuth: - eval:read components: schemas: PostApiOnboardingSetupPlanRequest: type: object properties: plan: oneOf: - type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' additionalProperties: false required: - plan PostApiOnboardingSetupPlanResponse200ApplicationJson: type: object properties: plan: type: object properties: schemaVersion: type: number enum: - 1 mode: type: string enum: - plan project: type: object properties: name: type: string cwd: type: string runtime: type: string packageManager: oneOf: - type: 'null' - type: string hasTestScript: type: boolean testScript: oneOf: - type: 'null' - type: string isPolyglot: type: boolean isWorkspace: type: boolean gitRoot: oneOf: - type: 'null' - type: string hasPackageJson: type: boolean hasPythonMarkers: type: boolean packageHandlers: type: array items: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' aiUsage: oneOf: - type: 'null' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' additionalProperties: false required: - name - cwd - runtime - packageManager - hasTestScript - testScript - isPolyglot - isWorkspace - gitRoot - hasPackageJson - hasPythonMarkers - packageHandlers - aiUsage manifest: type: object properties: path: oneOf: - type: 'null' - type: string schemaVersion: oneOf: - type: 'null' - type: number additionalProperties: false required: - path - schemaVersion willWrite: type: array items: type: object properties: path: type: string action: oneOf: - type: string enum: - create - type: string enum: - skip-existing description: type: string additionalProperties: false required: - path - action - description willExecute: type: array items: type: object properties: command: type: string when: type: string defaultDuringInit: type: boolean enum: - false additionalProperties: false required: - command - when - defaultDuringInit networkAndCredentials: type: object properties: initApply: type: string enum: - none notes: type: array items: type: string additionalProperties: false required: - initApply - notes rollback: type: object properties: boundary: type: string manual: type: string transactionCommand: type: string additionalProperties: false required: - boundary - manual - transactionCommand nextCommands: type: array items: type: string additionalProperties: false required: - schemaVersion - mode - project - manifest - willWrite - willExecute - networkAndCredentials - rollback - nextCommands projectStatus: type: object properties: schemaVersion: type: number enum: - 1 inspectedAt: type: string source: type: string enum: - cli-init-plan projectName: type: string runtime: type: string cwd: type: string gitRoot: oneOf: - type: 'null' - type: string isPolyglot: type: boolean isWorkspace: type: boolean manifestPath: oneOf: - type: 'null' - type: string manifestRevision: oneOf: - type: 'null' - type: string plannedWrites: type: number plannedCreates: type: number plannedSkips: type: number willExecuteCount: type: number networkPolicy: type: string enum: - none rollbackBoundary: type: string rollbackCommand: type: string nextCommands: type: array items: type: string baselineLineage: type: string enum: - pending selectedTarget: type: string latestRun: type: 'null' connectorHealth: type: string enum: - not-connected prGateState: type: string enum: - not-configured nextSafeAction: type: string additionalProperties: false required: - schemaVersion - inspectedAt - source - projectName - runtime - cwd - gitRoot - isPolyglot - isWorkspace - manifestPath - manifestRevision - plannedWrites - plannedCreates - plannedSkips - willExecuteCount - networkPolicy - rollbackBoundary - rollbackCommand - nextCommands - baselineLineage - selectedTarget - latestRun - connectorHealth - prGateState - nextSafeAction onboardingState: type: object properties: completedSteps: type: array items: type: string skipped: type: boolean selectedScopes: type: array items: type: string providerKeyProvider: oneOf: - type: 'null' - type: string customizedAt: oneOf: - type: 'null' - type: string wizard: type: object properties: selectedPath: oneOf: - type: 'null' - type: string enum: - repository - type: string enum: - standalone - type: string enum: - deployed-api - type: string enum: - existing-traces - type: string enum: - cloud-governance evaluationId: oneOf: - type: 'null' - type: number evaluationName: oneOf: - type: 'null' - type: string testCaseIds: type: array items: type: number baselineStatus: oneOf: - type: 'null' - type: string enum: - pending - type: string enum: - imported - type: string enum: - ready currentStep: type: number completed: type: boolean inspectedPlan: oneOf: - type: 'null' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' projectStatus: oneOf: - type: 'null' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' additionalProperties: false required: - selectedPath - evaluationId - evaluationName - testCaseIds - baselineStatus - currentStep - completed additionalProperties: false required: - completedSteps - skipped - selectedScopes - providerKeyProvider - customizedAt additionalProperties: false required: - plan - projectStatus - onboardingState JsonValue: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' ApiError: type: object properties: error: type: object properties: code: type: string enum: - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - VALIDATION_ERROR - RATE_LIMITED - CONFLICT - INTERNAL_ERROR - SERVICE_UNAVAILABLE - QUOTA_EXCEEDED - NO_ORG_MEMBERSHIP - CROSS_ORG_REFERENCE - INCOMPLETE - MALFORMED message: type: string details: {} requestId: type: string format: uuid required: - code - message required: - error responses: ValidationError: description: Validation error content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ApiError' Conflict: description: Conflict content: application/json: schema: $ref: '#/components/schemas/ApiError' RateLimited: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ApiError' InternalError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key or Session Token ````