GET
/
api
/
v1
/
external-functions
curl --request GET \
  --url https://api.play.ai/api/v1/external-functions \
  --header 'Authorization: Bearer <token>' \
  --header 'X-USER-ID: <api-key>'
[
  {
    "id": "f0gZrOKBKL7veJ6o1M",
    "name": "My External Function",
    "description": "My external function is the best external function",
    "endpointUrl": "https://my.external.function.example.com/api/v1/external-function",
    "method": "GET",
    "parameters": [
      {
        "type": "number",
        "name": "MyExternalFunctionParameter",
        "description": "My external function parameter is the best external function parameter",
        "id": "MyExternalFunctionParameterId",
        "parameterPosition": "body"
      }
    ]
  }
]

Retrieve all information about all external functions that you have created.

Authorizations

​
Authorization
string
header
required

Your secret API key from PlayAI, formatted as Bearer YOUR_SECRET_API_KEY.

​
X-USER-ID
string
header
required

Your unique user ID from PlayAI.

Headers

​
accept
enum<string>
Available options:
application/json

Response

200 - application/json
External functions retrieved.
​
id
string

The unique ID for each external function.

Example:

"f0gZrOKBKL7veJ6o1M"

​
name
string

The external function's name

Maximum length: 250
Example:

"My External Function"

​
description
string

The external function's description

Maximum length: 500
Example:

"My external function is the best external function"

​
endpointUrl
string

The external function's endpoint URL

Maximum length: 500
Example:

"https://my.external.function.example.com/api/v1/external-function"

​
method
enum<string>
default:GET

The external function's method

Available options:
POST,
GET,
PUT,
DELETE
​
parameters
object[]

Was this page helpful?