Skip to main content
POST
/
v1
/
functions
cURL
curl --request POST \
  --url https://api.buildwithchirp.com/v1/functions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "my-function",
  "name": "My Function",
  "description": "A function that does something useful"
}
'
{
  "id": "fn_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "slug": "my-function",
  "name": "My Function",
  "description": "A function that does something useful",
  "createdAt": "2021-08-01T00:00:00Z",
  "updatedAt": "2021-08-01T00:00:00Z"
}

Authorizations

​
Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Body

application/json
​
slug
string
required

Unique slug identifier for the function

Minimum string length: 1
Example:

"my-function"

​
name
string

Human-readable name of the function

Minimum string length: 1
Example:

"My Function"

​
description
string

Description of the function

Example:

"A function that does something useful"

Response

Create a new function

​
id
string
required

Unique identifier for a Function. Format: fn_[test_]{ksuid}

Pattern: ^fn_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"fn_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
slug
string
required

Function slug identifier

Example:

"my-function"

​
name
string
required

Human-readable name of the function

Example:

"My Function"

​
description
string | null
required

Description of the function

Example:

"A function that does something useful"

​
createdAt
string<date-time>
required

When the function was created

Example:

"2021-08-01T00:00:00Z"

​
updatedAt
string<date-time>
required

When the function was last updated

Example:

"2021-08-01T00:00:00Z"