Skip to content
post

Create Execution

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/functions/{functionId}/executions

Description

Trigger a function execution. The returned object will return you the current execution status. You can ping the Get Execution endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.

Required scopes

execution.write

Authentication

Initialize the Appwrite client with setProject() and ensure the user is signed in. The SDK sends the session header automatically after login.

Rate limit

Up to 60 requests per minute for each IP address calling this endpoint.
Server API key requests bypass this rate limit.

Path

string
Required

Function ID.

Body

string

String of custom data to send to function.

boolean

Execute code asynchronously. Default value is true.

Status
Content type
201
application/json

Execution

Name
Type
Description
string

Execution ID.

integer

Execution creation date in Unix timestamp.

integer

Execution update date in Unix timestamp.

arrayof string

Execution read permissions.

string

Function ID.

string

The trigger that caused the function to execute. Possible values can be: http, schedule, or event.

string

The status of the function execution. Possible values can be: waiting, processing, completed, or failed.

integer

The script status code.

string

The script response output string. Logs the last 4,000 characters of the execution response output.

string

The script stderr output string. Logs the last 4,000 characters of the execution stderr output

number

The script execution time in seconds.

Kotlin
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import kotlinx.coroutines.GlobalScope
import kotlinx.coroutines.launch
import io.appwrite.Client
import io.appwrite.services.Functions


class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)


        val client = Client(applicationContext)
            .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
            .setProject("5df5acd0d48c2") // Your project ID


        val functions = Functions(client)


        GlobalScope.launch {
            val response = functions.createExecution(
                functionId = "[FUNCTION_ID]",
            )
            val json = response.body?.string()        
        }
    }
}