Skip to main content
POST
/
v2.0
/
functions
/
{functionId}
/
trigger
Create a Function Instance
curl --request POST \
  --url 'https://api-trial.cognigy.ai/new/v2.0/functions/{functionId}/trigger?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "functionInstanceId": "<string>"
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

ā€‹
api_key
string
query
required

Supply the API Key in the Url-Query

ā€‹
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

ā€‹
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

ā€‹
functionId
string
required

The Id of the Function

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Response

Object with the function instance id.

ā€‹
functionInstanceId
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$