Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Get a Function Instance
Gets a Function instance from a Function.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/functions/{functionId}/instances/{functionInstanceId} \
--header 'X-API-Key: <api-key>'{
"_id": "<string>",
"functionReference": "<string>",
"trigger": "flow",
"status": "active",
"error": "<string>",
"createdAt": 1694518620,
"finishedAt": 1694518620
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The Id of the Function
24^[a-z0-9]{24}$The Id of the Function Instance
24^[a-z0-9]{24}$Response
Returns a Function Instance object
24^[a-z0-9]{24}$24^[a-z0-9]{24}$How was this function instance triggered, e.g. was it spawned while executing a Flow?
flow, manual "flow"
The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.
queued, active, done, error "active"
Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/functions/{functionId}/instances/{functionInstanceId} \
--header 'X-API-Key: <api-key>'{
"_id": "<string>",
"functionReference": "<string>",
"trigger": "flow",
"status": "active",
"error": "<string>",
"createdAt": 1694518620,
"finishedAt": 1694518620
}