External Functions
Get External Function
Get an external function.
GET
/
api
/
v1
/
external-functions
/
{functionId}
Retrieve all information about the external function with the specified ID.
Authorizations
AUTHORIZATION
string
headerrequiredAPI key required for this endpoint. Use Bearer YOUR_SECRET_API_KEY
. Get your key from https://play.ai/developers.
X-USER-ID
string
headerrequiredUser ID required for this endpoint. Get it from https://play.ai/developers.
Headers
accept
enum<string>
Available options:
application/json
Path Parameters
functionId
string
requiredThe external function's ID.
Response
200 - application/json
id
string
The unique ID for each external function.
name
string
The external function's name
Maximum length:
250
description
string
The external function's description
Maximum length:
500
endpointUrl
string
The external function's endpoint URL
Maximum length:
500
method
enum<string>
default: GETThe external function's method
Available options:
POST
, GET
, PUT
, DELETE
parameters
object[]