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

# Get External Function

> Retrieve all information about the external function with the specified ID.



## OpenAPI

````yaml GET /api/v1/external-functions/{functionId}
openapi: 3.1.0
info:
  title: PlayAI API
  version: 1.0.0
  description: |
    A single, combined OpenAPI specification that merges:
      • PlayAI Agent API
      • PlayAI PlayNote API
      • PlayAI Text-to-Speech (TTS) API
      • PlayAI Dialog Turbo API

    This file contains all endpoints, schemas, and components 
    from the four original specs. See "Merged Issues" below 
    for notes on how certain conflicts were resolved.
servers:
  - url: https://api.play.ai
security:
  - ApiKeyAuth: []
    XUserIdAuth: []
paths:
  /api/v1/external-functions/{functionId}:
    get:
      description: Get an external function.
      parameters:
        - name: functionId
          in: path
          description: The external function's ID.
          required: true
          schema:
            $ref: '#/components/schemas/ExternalFunctionId'
        - name: accept
          in: header
          required: false
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          $ref: '#/components/responses/ExternalFunctionResourceResponse'
      security:
        - ApiKeyAuth: []
          XUserIdAuth: []
components:
  schemas:
    ExternalFunctionId:
      description: The unique ID for each external function.
      type: string
      example: f0gZrOKBKL7veJ6o1M
    ExternalFunctionResource:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ExternalFunctionId'
        name:
          type: string
          nullable: false
          maxLength: 250
        description:
          type: string
          nullable: false
          maxLength: 500
        endpointUrl:
          type: string
          nullable: false
          maxLength: 500
        method:
          type: string
          nullable: false
          enum:
            - POST
            - GET
            - PUT
            - DELETE
          default: GET
        parameters:
          type: array
          nullable: false
          items:
            oneOf:
              - type: object
                properties:
                  type:
                    type: string
                    enum:
                      - number
                      - string
                      - boolean
                  name:
                    type: string
                    nullable: false
                    maxLength: 250
                  description:
                    type: string
                    nullable: false
                    maxLength: 500
                  id:
                    type: string
                    nullable: false
                    maxLength: 250
                  parameterPosition:
                    type: string
                    enum:
                      - body
                      - header
                      - query
                      - url
                    default: body
                required:
                  - name
                  - id
                  - type
              - type: object
                properties:
                  type:
                    type: string
                    enum:
                      - enum
                  name:
                    type: string
                    nullable: false
                    maxLength: 250
                  description:
                    type: string
                    nullable: false
                    maxLength: 500
                  id:
                    type: string
                    nullable: false
                    maxLength: 250
                  parameterPosition:
                    type: string
                    enum:
                      - body
                      - header
                      - query
                      - url
                    default: body
                  values:
                    type: array
                    items:
                      type: string
                    minItems: 1
                required:
                  - name
                  - id
                  - type
                  - values
              - type: object
                properties:
                  type:
                    type: string
                    enum:
                      - const
                  name:
                    type: string
                    nullable: false
                    maxLength: 250
                  description:
                    type: string
                    nullable: false
                    maxLength: 500
                  id:
                    type: string
                    nullable: false
                    maxLength: 250
                  parameterPosition:
                    type: string
                    enum:
                      - body
                      - header
                      - query
                      - url
                    default: body
                  value:
                    type: string
                    nullable: false
                    maxLength: 250
                  constType:
                    type: string
                    enum:
                      - string
                      - number
                      - boolean
                      - enum
                    default: string
                required:
                  - name
                  - id
                  - type
                  - value
  responses:
    ExternalFunctionResourceResponse:
      description: External function resource response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExternalFunctionResource'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >
        Your secret API key from [PlayAI](https://play.ai/api/keys), formatted
        as `Bearer YOUR_SECRET_API_KEY`.
    XUserIdAuth:
      type: apiKey
      in: header
      name: X-USER-ID
      description: |
        Your unique user ID from [PlayAI](https://play.ai/api/keys).
      x-prompt: What is your PlayAI user ID?

````