Typescript (SDK)

import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.scriptRuns.create(<value>);

  console.log(result);
}

run();

curl --request POST \
  --url https://api.crevio.co/v1/script_runs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "args": [
    "<string>"
  ],
  "timeout_seconds": 300,
  "wait_seconds": 0
}
'

import requests

url = "https://api.crevio.co/v1/script_runs"

payload = {
    "code": "<string>",
    "args": ["<string>"],
    "timeout_seconds": 300,
    "wait_seconds": 0
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({code: '<string>', args: ['<string>'], timeout_seconds: 300, wait_seconds: 0})
};

fetch('https://api.crevio.co/v1/script_runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.crevio.co/v1/script_runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>',
    'args' => [
        '<string>'
    ],
    'timeout_seconds' => 300,
    'wait_seconds' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.crevio.co/v1/script_runs"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 300,\n  \"wait_seconds\": 0\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.crevio.co/v1/script_runs")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 300,\n  \"wait_seconds\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.crevio.co/v1/script_runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 300,\n  \"wait_seconds\": 0\n}"

response = http.request(request)
puts response.read_body

{
  "object": "<string>",
  "id": "<string>",
  "status": "queued",
  "result": "<unknown>",
  "output": "<string>",
  "error": "<string>",
  "args": [
    "<string>"
  ],
  "calls": [
    {}
  ],
  "approvals": [
    {
      "object": "approval",
      "id": "<string>",
      "approval_id": "<string>",
      "status": "draft",
      "kind": "pipedream",
      "action_type": "<string>",
      "title": "<string>",
      "app_slug": "<string>",
      "tool_name": "<string>",
      "result": {},
      "error": "<string>",
      "reason": "<string>",
      "chat_id": "<string>",
      "created_at": "<string>",
      "resolved_at": "<string>"
    }
  ],
  "pending_approval_ids": [
    "<string>"
  ],
  "artifacts": [
    {
      "object": "<string>",
      "id": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "size": 123
    }
  ],
  "timeout_seconds": 123,
  "started_at": "<string>",
  "completed_at": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "object": "<string>",
  "id": "<string>",
  "status": "queued",
  "result": "<unknown>",
  "output": "<string>",
  "error": "<string>",
  "args": [
    "<string>"
  ],
  "calls": [
    {}
  ],
  "approvals": [
    {
      "object": "approval",
      "id": "<string>",
      "approval_id": "<string>",
      "status": "draft",
      "kind": "pipedream",
      "action_type": "<string>",
      "title": "<string>",
      "app_slug": "<string>",
      "tool_name": "<string>",
      "result": {},
      "error": "<string>",
      "reason": "<string>",
      "chat_id": "<string>",
      "created_at": "<string>",
      "resolved_at": "<string>"
    }
  ],
  "pending_approval_ids": [
    "<string>"
  ],
  "artifacts": [
    {
      "object": "<string>",
      "id": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "size": 123
    }
  ],
  "timeout_seconds": 123,
  "started_at": "<string>",
  "completed_at": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "bad_request",
    "message": "The request was malformed or contained invalid parameters"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "authentication_required",
    "message": "You did not provide an API key."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "forbidden",
    "message": "You do not have permission to perform this action"
  }
}

{
  "error": {
    "type": "validation_error",
    "code": "validation_failed",
    "message": "Email is required",
    "errors": {
      "email": [
        "can't be blank"
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Please retry later."
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred"
  }
}

Script runs

Run a script

Runs JavaScript on the account’s computer with bun, with no agent turn, as the key’s owner (account admins only; team keys cannot). tools.<namespace>.<function>(args) calls the Crevio API and connected integrations, and the script’s last expression is its result. args reach the script as the global args (and process.argv). Files written into the directory named by the global outputDir (20 at most, 50 MB each) come back as artifacts. A call that needs approval does not run: it resolves to {pending: true, draft_id, approval}, the script carries on, and the run lists it in approvals and pending_approval_ids. Approving it (POST /approvals//approve) runs that one frozen call, never the script again. 200 when it finished within wait_seconds, 202 otherwise: poll GET /script_runs/. At most 4 runs in flight per user and 8 per account (429). Needs the scripts scope.

POST

script_runs

Typescript (SDK)

import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.scriptRuns.create(<value>);

  console.log(result);
}

run();

curl --request POST \
  --url https://api.crevio.co/v1/script_runs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "args": [
    "<string>"
  ],
  "timeout_seconds": 300,
  "wait_seconds": 0
}
'

import requests

url = "https://api.crevio.co/v1/script_runs"

payload = {
    "code": "<string>",
    "args": ["<string>"],
    "timeout_seconds": 300,
    "wait_seconds": 0
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({code: '<string>', args: ['<string>'], timeout_seconds: 300, wait_seconds: 0})
};

fetch('https://api.crevio.co/v1/script_runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.crevio.co/v1/script_runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>',
    'args' => [
        '<string>'
    ],
    'timeout_seconds' => 300,
    'wait_seconds' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.crevio.co/v1/script_runs"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 300,\n  \"wait_seconds\": 0\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.crevio.co/v1/script_runs")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 300,\n  \"wait_seconds\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.crevio.co/v1/script_runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 300,\n  \"wait_seconds\": 0\n}"

response = http.request(request)
puts response.read_body

{
  "object": "<string>",
  "id": "<string>",
  "status": "queued",
  "result": "<unknown>",
  "output": "<string>",
  "error": "<string>",
  "args": [
    "<string>"
  ],
  "calls": [
    {}
  ],
  "approvals": [
    {
      "object": "approval",
      "id": "<string>",
      "approval_id": "<string>",
      "status": "draft",
      "kind": "pipedream",
      "action_type": "<string>",
      "title": "<string>",
      "app_slug": "<string>",
      "tool_name": "<string>",
      "result": {},
      "error": "<string>",
      "reason": "<string>",
      "chat_id": "<string>",
      "created_at": "<string>",
      "resolved_at": "<string>"
    }
  ],
  "pending_approval_ids": [
    "<string>"
  ],
  "artifacts": [
    {
      "object": "<string>",
      "id": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "size": 123
    }
  ],
  "timeout_seconds": 123,
  "started_at": "<string>",
  "completed_at": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "object": "<string>",
  "id": "<string>",
  "status": "queued",
  "result": "<unknown>",
  "output": "<string>",
  "error": "<string>",
  "args": [
    "<string>"
  ],
  "calls": [
    {}
  ],
  "approvals": [
    {
      "object": "approval",
      "id": "<string>",
      "approval_id": "<string>",
      "status": "draft",
      "kind": "pipedream",
      "action_type": "<string>",
      "title": "<string>",
      "app_slug": "<string>",
      "tool_name": "<string>",
      "result": {},
      "error": "<string>",
      "reason": "<string>",
      "chat_id": "<string>",
      "created_at": "<string>",
      "resolved_at": "<string>"
    }
  ],
  "pending_approval_ids": [
    "<string>"
  ],
  "artifacts": [
    {
      "object": "<string>",
      "id": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "size": 123
    }
  ],
  "timeout_seconds": 123,
  "started_at": "<string>",
  "completed_at": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "bad_request",
    "message": "The request was malformed or contained invalid parameters"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "authentication_required",
    "message": "You did not provide an API key."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "forbidden",
    "message": "You do not have permission to perform this action"
  }
}

{
  "error": {
    "type": "validation_error",
    "code": "validation_failed",
    "message": "Email is required",
    "errors": {
      "email": [
        "can't be blank"
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Please retry later."
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred"
  }
}

Authorizations

Authorization

string

header

required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key

string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json

code

string

required

The JavaScript to run.

Maximum string length: 100000

args

string[]

Values the script reads from the global args.

Maximum array length: 16

Maximum string length: 2000

timeout_seconds

integer

default:300

How long the script may run.

Required range: 1 <= x <= 600

wait_seconds

integer

default:0

Hold the response until the script finishes, up to this many seconds.

Required range: 0 <= x <= 90

Response

The script finished within wait_seconds

object

string

required

string

required

status

enum<string>

required

Available options:

queued,

in_progress,

completed,

failed,

cancelled,

timed_out

result

any

required

The script's last expression, as JSON.

output

string | null

required

What the script printed: its start and end when long, with the cut marked.

error

string | null

required

args

string[]

required

calls

object[]

required

Every tool call the script made, in order: {role, status, read_only, error_code, approval_id}. A 202 call did not run and names its approval.

approvals

object[]

required

What the script's gated calls froze, as each stands now. Approving one runs that call, never the script again.

Show child attributes

pending_approval_ids

string[]

required

Approvals still waiting for a decision: POST /approvals/{id}/approve or /deny.

artifacts

object[]

required

Files the script wrote to outputDir.

Show child attributes

timeout_seconds

integer

required

started_at

string | null

required

completed_at

string | null

required

created_at

string<date-time>

required

Overview

Products & catalog

Selling & orders

Customers & leads

Marketing

Website & content

Scheduling & bookings

Calls & phone

AI & automation

Media library

Business & formation

Account & platform

Run a script

Authorizations

Headers

Body

Response