> ## Documentation Index > Fetch the complete documentation index at: https://crowdlisten.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Complete Onboarding > Create the complete onboarding workspace in one database transaction. ## OpenAPI ````yaml /api/openapi.json post /api/entities/onboarding openapi: 3.1.0 info: title: CrowdListen Agent API description: >- Configure sources, collect and retain originals, run durable analysis, and read or revise cited insights. Humans and agents share authorized entity/project records, research jobs and evidence history. version: 1.0.0 servers: - url: https://agent.crowdlisten.com description: Production - url: http://localhost:8000 description: Local development security: [] paths: /api/entities/onboarding: post: tags: - entities summary: Complete Onboarding description: Create the complete onboarding workspace in one database transaction. operationId: complete_onboarding_api_entities_onboarding_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CompleteOnboardingRequest' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: CompleteOnboardingRequest: properties: research_objectives: anyOf: - items: $ref: '#/components/schemas/ResearchObjective' type: array maxItems: 5 - type: 'null' title: Research Objectives company: $ref: '#/components/schemas/OnboardingCompanyRequest' request_id: anyOf: - type: string format: uuid - type: 'null' title: Request Id workspace_id: anyOf: - type: string format: uuid - type: 'null' title: Workspace Id source_intent: items: type: string type: array maxItems: 16 title: Source Intent collection_mode: type: string enum: - agent - server title: Collection Mode default: server collection_client: anyOf: - type: string enum: - Cursor - Claude Code - Codex - OpenClaw - type: 'null' title: Collection Client products: items: $ref: '#/components/schemas/OnboardingRelatedEntityRequest' type: array maxItems: 20 title: Products competitors: items: $ref: '#/components/schemas/OnboardingRelatedEntityRequest' type: array maxItems: 20 title: Competitors type: object required: - company title: CompleteOnboardingRequest HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ResearchObjective: properties: id: type: string maxLength: 100 minLength: 1 title: Id title: type: string maxLength: 120 minLength: 1 title: Title question: type: string maxLength: 1000 minLength: 1 title: Question decision: type: string maxLength: 1000 minLength: 1 title: Decision evidence: type: string maxLength: 1000 minLength: 1 title: Evidence workflow: anyOf: - $ref: '#/components/schemas/WorkflowDefinition' - type: 'null' additionalProperties: false type: object required: - id - title - question - decision - evidence title: ResearchObjective OnboardingCompanyRequest: properties: name: type: string maxLength: 200 minLength: 1 title: Name url: anyOf: - type: string - type: 'null' title: Url keywords: items: type: string type: array title: Keywords collection_targets: anyOf: - additionalProperties: items: $ref: '#/components/schemas/OnboardingAccountTarget' type: array type: object - type: 'null' title: Collection Targets platforms: items: type: string type: array title: Platforms type: object required: - name title: OnboardingCompanyRequest OnboardingRelatedEntityRequest: properties: name: type: string maxLength: 200 minLength: 1 title: Name url: anyOf: - type: string - type: 'null' title: Url keywords: items: type: string type: array title: Keywords collection_targets: anyOf: - additionalProperties: items: $ref: '#/components/schemas/OnboardingAccountTarget' type: array type: object - type: 'null' title: Collection Targets type: object required: - name title: OnboardingRelatedEntityRequest ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError WorkflowDefinition: properties: version: type: integer const: 1 title: Version default: 1 instructions: type: string maxLength: 8000 title: Instructions default: '' synthesis_model: anyOf: - type: string enum: - gpt-5.4-mini - gpt-5.5 - fireworks/auto - type: 'null' title: Synthesis Model model_routing: anyOf: - $ref: '#/components/schemas/ModelRouting' - type: 'null' filter_relevance: anyOf: - type: boolean - type: 'null' title: Filter Relevance document_destination: anyOf: - $ref: '#/components/schemas/DocumentDestination' - type: 'null' inputs: $ref: '#/components/schemas/WorkflowInputs' additionalProperties: false type: object title: WorkflowDefinition OnboardingAccountTarget: properties: target: type: string maxLength: 500 minLength: 1 title: Target role: type: string enum: - official - employee - founder - advocate - affiliate - organization_affiliate - creator - competitor - unknown title: Role default: unknown organization_affiliation: anyOf: - $ref: '#/components/schemas/XAffiliation' - type: 'null' additionalProperties: false type: object required: - target title: OnboardingAccountTarget ModelRouting: properties: cost_tier: type: string enum: - low - medium - high title: Cost Tier default: medium allowed_models: anyOf: - items: type: string type: array maxItems: 8 minItems: 1 - type: 'null' title: Allowed Models additionalProperties: false type: object title: ModelRouting DocumentDestination: properties: provider: type: string enum: - google_docs - notion title: Provider url: type: string maxLength: 2048 title: Url additionalProperties: false type: object required: - provider - url title: DocumentDestination description: >- Agent-managed delivery preference; not a provider connection or export job. WorkflowInputs: properties: platforms: items: type: string enum: - twitter - slack type: array maxItems: 2 title: Platforms account_roles: items: type: string enum: - official - organization_affiliate - affiliate - competitor - employee - founder - organic - unknown type: array maxItems: 8 title: Account Roles slack_channels: items: $ref: '#/components/schemas/SlackWorkflowChannel' type: array maxItems: 5 title: Slack Channels lookback_days: type: integer maximum: 90 minimum: 1 title: Lookback Days default: 7 max_sources: type: integer maximum: 200 minimum: 1 title: Max Sources default: 25 x_queries: anyOf: - items: type: string type: array maxItems: 3 - type: 'null' title: X Queries x_language: anyOf: - type: string enum: - en - ja - zh - ko - es - fr - de - pt - ar - hi - type: 'null' title: X Language x_min_likes: anyOf: - type: integer maximum: 1000000 minimum: 0 - type: 'null' title: X Min Likes additionalProperties: false type: object title: WorkflowInputs XAffiliation: properties: organization_id: type: string pattern: ^[0-9]{1,19}$ title: Organization Id organization_username: type: string pattern: ^[A-Za-z0-9_]{1,15}$ title: Organization Username account_id: type: string pattern: ^[0-9]{1,19}$ title: Account Id observed_at: type: string format: date-time title: Observed At additionalProperties: false type: object required: - organization_id - organization_username - account_id - observed_at title: XAffiliation SlackWorkflowChannel: properties: team_id: type: string pattern: ^T[A-Z0-9]{2,30}$ title: Team Id channel_id: type: string pattern: ^[CG][A-Z0-9]{2,30}$ title: Channel Id name: type: string maxLength: 120 title: Name default: '' additionalProperties: false type: object required: - team_id - channel_id title: SlackWorkflowChannel ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.