v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Functions

Get a Function Instance

Gets a Function instance from a Function.

get/v2.0/functions/{functionId}/instances/{functionInstanceId}

Path parameters

functionIdstring required

The Id of the Function

functionInstanceIdstring required

The Id of the Function Instance

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

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.

Response

Returns a Function Instance object

_idstring

functionReferencestring

trigger'flow' | 'manual'

How was this function instance triggered, e.g. was it spawned while executing a Flow?

status'queued' | 'active' | 'done' | 'error'

The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.

errorstring

createdAtinteger

Unix-timestamp

finishedAtinteger

Unix-timestamp

Example response

{
  "trigger": "flow",
  "status": "active",
  "createdAt": 1694518620,
  "finishedAt": 1694518620
}