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

# Get a node type

> Retrieve the configuration schema for one workflow node type.

Use a node-type name returned by [List node types](https://docs.agents.labs.bandwidth.com/api-reference/node-types/list.md). Names are strings rather than numeric IDs.

The response is that node's specification. An unknown name returns `404`. Use the specification to construct node data, then validate the complete graph before publishing.


## OpenAPI

````yaml GET /api/v1/node-types/{name}
openapi: 3.1.0
info:
  title: Bandwidth Agent Builder API
  version: v1
  description: >-
    Manage agents, place calls, and retrieve conversation results in your
    workspace.
servers:
  - url: https://agents.labs.bandwidth.com
    description: Workspace API
security: []
paths:
  /api/v1/node-types/{name}:
    get:
      tags:
        - node-types
      summary: Get a node type
      description: >-
        **Authorization:** Accepts a Labs OAuth bearer token or a Labs API key.
        Workspace-scoped resources require membership in the requested
        workspace.


        Retrieve the configuration schema for one workflow node type.
      operationId: get_node_type_api_v1_node_types__name__get
      parameters:
        - in: path
          name: name
          required: true
          schema:
            title: Name
            type: string
        - description: >-
            Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace
            ID to access. The key owner must be a current member. Missing or
            invalid IDs return 400; non-member workspaces return 403. Not
            required for bearer authentication, which uses the user's selected
            workspace.
          in: header
          name: X-VOAI-ORGANIZATION-ID
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Required with X-BW-LABS-AGENTS-API-KEY: the positive local
              workspace ID to access. The key owner must be a current member.
              Missing or invalid IDs return 400; non-member workspaces return
              403. Not required for bearer authentication, which uses the user's
              selected workspace.
            title: X-Voai-Organization-Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeSpec'
          description: Successful Response
        '400':
          description: Invalid request or missing/invalid workspace header with an API key.
        '401':
          description: Missing, invalid, or expired credential.
        '403':
          description: >-
            The account lacks access to the workspace, resource, or required
            role.
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - LabsAuth: []
        - LabsApiKey: []
components:
  schemas:
    NodeSpec:
      additionalProperties: false
      properties:
        category:
          $ref: '#/components/schemas/NodeCategory'
        description:
          minLength: 1
          title: Description
          type: string
        display_name:
          title: Display Name
          type: string
        examples:
          items:
            $ref: '#/components/schemas/NodeExample'
          title: Examples
          type: array
        graph_constraints:
          anyOf:
            - $ref: '#/components/schemas/GraphConstraints'
            - type: 'null'
        icon:
          title: Icon
          type: string
        llm_hint:
          anyOf:
            - type: string
            - type: 'null'
          title: Llm Hint
        name:
          title: Name
          type: string
        properties:
          items:
            $ref: '#/components/schemas/PropertySpec'
          title: Properties
          type: array
        version:
          default: 1.0.0
          title: Version
          type: string
      required:
        - name
        - display_name
        - description
        - category
        - icon
        - properties
      title: NodeSpec
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    NodeCategory:
      enum:
        - call_node
        - global_node
        - trigger
        - integration
      title: NodeCategory
      type: string
    NodeExample:
      additionalProperties: false
      properties:
        data:
          additionalProperties: true
          title: Data
          type: object
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        name:
          title: Name
          type: string
      required:
        - name
        - data
      title: NodeExample
      type: object
    GraphConstraints:
      additionalProperties: false
      properties:
        max_incoming:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Incoming
        max_outgoing:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Outgoing
        min_incoming:
          anyOf:
            - type: integer
            - type: 'null'
          title: Min Incoming
        min_outgoing:
          anyOf:
            - type: integer
            - type: 'null'
          title: Min Outgoing
      title: GraphConstraints
      type: object
    PropertySpec:
      additionalProperties: false
      properties:
        default:
          title: Default
        description:
          minLength: 1
          title: Description
          type: string
        display_name:
          title: Display Name
          type: string
        display_options:
          anyOf:
            - $ref: '#/components/schemas/DisplayOptions'
            - type: 'null'
        editor:
          anyOf:
            - type: string
            - type: 'null'
          title: Editor
        extra:
          additionalProperties: true
          title: Extra
          type: object
        llm_hint:
          anyOf:
            - type: string
            - type: 'null'
          title: Llm Hint
        max_length:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Length
        max_value:
          anyOf:
            - type: number
            - type: 'null'
          title: Max Value
        min_length:
          anyOf:
            - type: integer
            - type: 'null'
          title: Min Length
        min_value:
          anyOf:
            - type: number
            - type: 'null'
          title: Min Value
        name:
          title: Name
          type: string
        options:
          anyOf:
            - items:
                $ref: '#/components/schemas/PropertyOption'
              type: array
            - type: 'null'
          title: Options
        pattern:
          anyOf:
            - type: string
            - type: 'null'
          title: Pattern
        placeholder:
          anyOf:
            - type: string
            - type: 'null'
          title: Placeholder
        properties:
          anyOf:
            - items:
                $ref: '#/components/schemas/PropertySpec'
              type: array
            - type: 'null'
          title: Properties
        required:
          default: false
          title: Required
          type: boolean
        type:
          $ref: '#/components/schemas/PropertyType'
      required:
        - name
        - type
        - display_name
        - description
      title: PropertySpec
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    DisplayOptions:
      additionalProperties: false
      properties:
        hide:
          anyOf:
            - additionalProperties:
                items: {}
                type: array
              type: object
            - type: 'null'
          title: Hide
        show:
          anyOf:
            - additionalProperties:
                items: {}
                type: array
              type: object
            - type: 'null'
          title: Show
      title: DisplayOptions
      type: object
    PropertyOption:
      additionalProperties: false
      properties:
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        label:
          title: Label
          type: string
        value:
          anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
          title: Value
      required:
        - value
        - label
      title: PropertyOption
      type: object
    PropertyType:
      enum:
        - string
        - number
        - boolean
        - options
        - multi_options
        - fixed_collection
        - json
        - tool_refs
        - document_refs
        - recording_ref
        - credential_ref
        - mention_textarea
        - url
      title: PropertyType
      type: string
  securitySchemes:
    LabsAuth:
      description: >-
        Bandwidth Labs OAuth access token. Uses the user's selected workspace;
        the workspace header is not required. Do not also send an API key.
        Bearer-only operations may additionally require the Labs `super_user`
        role.
      scheme: bearer
      type: http
    LabsApiKey:
      description: >-
        Bandwidth Labs API key. Also send `X-VOAI-ORGANIZATION-ID` with a
        positive local workspace ID belonging to the key owner. Access follows
        the owner's current workspace role. Do not also send a bearer token. API
        keys cannot access bearer-only or Labs `super_user` operations.
      in: header
      name: X-BW-LABS-AGENTS-API-KEY
      type: apiKey

````

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