GET
/
api
/
v1
/
external-functions
/
{functionId}
curl --request GET \
  --url https://api.play.ai/api/v1/external-functions/{functionId} \
  --header 'AUTHORIZATION: <api-key>' \
  --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 the external function with the specified ID.

Authorizations

​
AUTHORIZATION
string
header
required

API key required for this endpoint. Use Bearer YOUR_SECRET_API_KEY. Get your key from https://play.ai/developers.

​
X-USER-ID
string
header
required

User ID required for this endpoint. Get it from https://play.ai/developers.

Headers

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

Path Parameters

​
functionId
string
required

The external function's ID.

Example:

"f0gZrOKBKL7veJ6o1M"

Response

200 - application/json
External function resource response.
​
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?