> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neuralfactory.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Activate Use Case

> API key permission: Agents (Admin also opens it).



## OpenAPI

````yaml /api-reference/openapi.json post /use-cases/{use_case_id}/activate
openapi: 3.1.0
info:
  title: Neural Factory API
  version: 0.1.0
  description: >-
    The endpoints a program can call with an API key. Exchange the key's secret
    for a token at POST /apikeys/token and send it as a Bearer token.
servers:
  - url: https://api.neuralfactory.ai
    description: SaaS
  - url: https://{apiHost}
    description: 'Enterprise: the API address of your own deployment'
    variables:
      apiHost:
        default: api.example.com
        description: Your deployment's API host
security:
  - bearerAuth: []
tags:
  - name: API keys
  - name: Chat
  - name: Runs
  - name: Agents
  - name: Workflows
  - name: Schedules
  - name: Knowledge bases
  - name: Documents
  - name: Search
  - name: Skills
  - name: Toolkits
  - name: Files
  - name: Interactions
  - name: Usage and billing
  - name: Catalogue
  - name: Browser
  - name: Users
  - name: Groups
  - name: Builds
paths:
  /use-cases/{use_case_id}/activate:
    post:
      tags:
        - Catalogue
      summary: Activate Use Case
      description: 'API key permission: Agents (Admin also opens it).'
      operationId: activate_use_case_use_cases__use_case_id__activate_post
      parameters:
        - name: use_case_id
          in: path
          required: true
          schema:
            type: string
            title: Use Case Id
        - name: env
          in: query
          required: false
          schema:
            title: Env
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivateRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivationResult'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ActivateRequest:
      properties:
        knowledge_bases:
          additionalProperties:
            type: string
          type: object
          title: Knowledge Bases
        start:
          type: string
          enum:
            - on_demand
            - schedule
            - chat
          title: Start
        schedule:
          anyOf:
            - $ref: '#/components/schemas/Schedule'
            - type: 'null'
        approvers:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Approvers
        visibility:
          type: string
          enum:
            - private
            - public
            - groups
          title: Visibility
          default: private
        group_ids:
          items:
            type: string
          type: array
          title: Group Ids
      type: object
      required:
        - start
      title: ActivateRequest
      description: The answers of the activation steps.
    ActivationResult:
      properties:
        items:
          items:
            $ref: '#/components/schemas/CreatedItem'
          type: array
          title: Items
        todo:
          items:
            $ref: '#/components/schemas/Check'
          type: array
          title: Todo
      type: object
      required:
        - items
        - todo
      title: ActivationResult
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Schedule:
      properties:
        cron:
          type: string
          title: Cron
        timezone:
          type: string
          title: Timezone
      type: object
      required:
        - cron
        - timezone
      title: Schedule
    CreatedItem:
      properties:
        kind:
          type: string
          enum:
            - agent
            - workflow
          title: Kind
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        href:
          type: string
          title: Href
      type: object
      required:
        - kind
        - id
        - name
        - href
      title: CreatedItem
    Check:
      properties:
        id:
          type: string
          title: Id
        severity:
          type: string
          enum:
            - warn
            - info
          title: Severity
        title:
          type: string
          title: Title
        detail:
          type: string
          title: Detail
          default: ''
        fix:
          anyOf:
            - $ref: '#/components/schemas/CheckFix'
            - type: 'null'
      type: object
      required:
        - id
        - severity
        - title
      title: Check
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    CheckFix:
      properties:
        kind:
          type: string
          enum:
            - ask
            - open
            - connect
          title: Kind
        arg:
          type: string
          title: Arg
          default: ''
      type: object
      required:
        - kind
      title: CheckFix
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The access_token returned by POST /apikeys/token for an API key's
        secret.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.