Skip to main content
GET
/
api
/
v1
/
external-functions
cURL
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": "<string>",
    "description": "<string>",
    "endpointUrl": "<string>",
    "method": "GET",
    "parameters": [
      {
        "type": "number",
        "name": "<string>",
        "description": "<string>",
        "id": "<string>",
        "parameterPosition": "body"
      }
    ]
  }
]

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
Maximum length: 250
​
description
string
Maximum length: 500
​
endpointUrl
string
Maximum length: 500
​
method
enum<string>
default:GET
Available options:
POST,
GET,
PUT,
DELETE
​
parameters
object[]
  • Option 1
  • Option 2
  • Option 3