Skip to main content
GET
/
v2.0
/
functions
/
{functionId}
/
instances
/
{functionInstanceId}
Get a Function Instance
curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/functions/{functionId}/instances/{functionInstanceId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "_id": "<string>",
  "functionReference": "<string>",
  "trigger": "flow",
  "status": "active",
  "error": "<string>",
  "createdAt": 1694518620,
  "finishedAt": 1694518620
}

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}$
ā€‹
functionInstanceId
string
required

The Id of the Function Instance

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

Response

Returns a Function Instance object

ā€‹
_id
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
functionReference
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
trigger
enum<string>

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

Available options:
flow,
manual
Example:

"flow"

ā€‹
status
enum<string>

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

Available options:
queued,
active,
done,
error
Example:

"active"

ā€‹
error
string
ā€‹
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

ā€‹
finishedAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620