Function Run Start - Notte

POST

/

functions

/

{function_id}

/

runs

/

start

python

from notte_sdk import NotteClient

notte = NotteClient()
# retrieve the function
fn = notte.Function("<function_id>")
# Run the function, providing variables
response = fn.run(url="https://shop.notte.cc/")
print(f"Function completed with result: {response.result}")

import { NotteClient } from "notte-sdk";

const notte = new NotteClient();
const fn = notte.NotteFunction({
  function_id: "<function_id>",
});
const result = await fn.run({ url: "https://shop.notte.cc/" });
console.log("Function run result:", result);

curl -X POST -L "https://api.notte.cc/functions/$function_id/runs/start" \
  -H "Authorization: Bearer $NOTTE_API_KEY" \
  -H "x-notte-api-key: $NOTTE_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "function_id": "'"$function_id"'",
    "stream": false,
    "variables": {
      "url": "https://www.google.com"
    }
  }'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowPassword

Token URL: token

Headers

x-notte-api-key

string

required

x-db-preview

string | null

x-notte-request-origin

string | null

x-notte-sdk-version

string | null

Path Parameters

function_id

string

required

Body

application/json

workflow_id

string

required

The ID of the function to run

variables

Variables · object

The variables to run the function with

runtime

enum<string> | null

Override the saved function runtime; omit to inherit its default

Available options:

standard,

extended

stream

boolean

default:true

Whether to stream logs, or only return final response

callback_url

string | null

Optional https URL to POST the final status to once this reaches a terminal state, instead of polling for it. The body is the status endpoint's response plus an event field.

Response

Successful Response

⌘I

python

from notte_sdk import NotteClient

notte = NotteClient()
# retrieve the function
fn = notte.Function("<function_id>")
# Run the function, providing variables
response = fn.run(url="https://shop.notte.cc/")
print(f"Function completed with result: {response.result}")

import { NotteClient } from "notte-sdk";

const notte = new NotteClient();
const fn = notte.NotteFunction({
  function_id: "<function_id>",
});
const result = await fn.run({ url: "https://shop.notte.cc/" });
console.log("Function run result:", result);

curl -X POST -L "https://api.notte.cc/functions/$function_id/runs/start" \
  -H "Authorization: Bearer $NOTTE_API_KEY" \
  -H "x-notte-api-key: $NOTTE_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "function_id": "'"$function_id"'",
    "stream": false,
    "variables": {
      "url": "https://www.google.com"
    }
  }'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}