Skip to main content
POST
/
v2.0
/
functions
Create a Function
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/functions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "isDisabled": true,
  "projectId": "<string>"
}
'
{
  "name": "<string>",
  "code": "<string>",
  "isDisabled": true,
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

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

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

​
Accept
enum<string>

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.

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

Body

application/json
​
name
string
​
code
string
​
isDisabled
boolean
​
projectId
string

The unique identifier for the Project.

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

Response

Returns Function metadata object.

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

​
name
string
​
code
string
​
isDisabled
boolean
​
_id
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
createdAt
integer

Unix-timestamp

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

1694518620

​
lastChanged
integer

Unix-timestamp

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

1694518620

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