Test external API call

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/api-function-configs/test-run/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
  "requestUrl": "https://help.example.com/refunds",
  "requestMethod": "GET",
  "requestHeaders": {
    "name": "Example",
    "value": "message"
  },
  "requestBody": {
    "name": "Example",
    "value": "message"
  },
  "variables": {
    "name": "Example",
    "value": "message"
  }
}'

const response = await fetch('https://api-prod.usefini.com/v2/api-function-configs/test-run/public', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer fini_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  'id': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3',
  'requestUrl': 'https://help.example.com/refunds',
  'requestMethod': 'GET',
  'requestHeaders': {
    'name': 'Example',
    'value': 'message'
  },
  'requestBody': {
    'name': 'Example',
    'value': 'message'
  },
  'variables': {
    'name': 'Example',
    'value': 'message'
  }
}
  )
});

const data = await response.json();

import requests

response = requests.post(
    "https://api-prod.usefini.com/v2/api-function-configs/test-run/public",
    headers={"Authorization": "Bearer fini_your_api_key", "Content-Type": "application/json"},
    json={
    "id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
    "requestUrl": "https://help.example.com/refunds",
    "requestMethod": "GET",
    "requestHeaders": {
        "name": "Example",
        "value": "message"
    },
    "requestBody": {
        "name": "Example",
        "value": "message"
    },
    "variables": {
        "name": "Example",
        "value": "message"
    }
},
)

data = response.json()

{
  "success": true,
  "response": {
    "plan": "Enterprise",
    "status": "active"
  },
  "savedFields": {
    "plan": "Enterprise",
    "status": "active"
  }
}

POST

api-function-configs

test-run

public

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/api-function-configs/test-run/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
  "requestUrl": "https://help.example.com/refunds",
  "requestMethod": "GET",
  "requestHeaders": {
    "name": "Example",
    "value": "message"
  },
  "requestBody": {
    "name": "Example",
    "value": "message"
  },
  "variables": {
    "name": "Example",
    "value": "message"
  }
}'

const response = await fetch('https://api-prod.usefini.com/v2/api-function-configs/test-run/public', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer fini_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  'id': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3',
  'requestUrl': 'https://help.example.com/refunds',
  'requestMethod': 'GET',
  'requestHeaders': {
    'name': 'Example',
    'value': 'message'
  },
  'requestBody': {
    'name': 'Example',
    'value': 'message'
  },
  'variables': {
    'name': 'Example',
    'value': 'message'
  }
}
  )
});

const data = await response.json();

import requests

response = requests.post(
    "https://api-prod.usefini.com/v2/api-function-configs/test-run/public",
    headers={"Authorization": "Bearer fini_your_api_key", "Content-Type": "application/json"},
    json={
    "id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
    "requestUrl": "https://help.example.com/refunds",
    "requestMethod": "GET",
    "requestHeaders": {
        "name": "Example",
        "value": "message"
    },
    "requestBody": {
        "name": "Example",
        "value": "message"
    },
    "variables": {
        "name": "Example",
        "value": "message"
    }
},
)

data = response.json()

{
  "success": true,
  "response": {
    "plan": "Enterprise",
    "status": "active"
  },
  "savedFields": {
    "plan": "Enterprise",
    "status": "active"
  }
}

Runs a single HTTP call and returns the raw response, without persisting anything. Pass a saved step’s id to test it as stored, or send the request fields inline to try a call before saving.

Headers

string

required

Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs write scope.

string

required

application/json

Body parameters

string

Optional saved external API call step ID. When set, the stored URL, method, headers, and body are used, with any inline fields below overriding them. Stored secrets are resolved for the call.

string

Request URL. Required when id is omitted.

string

HTTP verb. Required when id is omitted.

object

Optional request headers.

object

Optional request body.

object

Optional values used to resolve ${fieldName} tokens in the URL, headers, and body.

Response

Returns a Data Step test-run result: success, statusCode, responseBody, and error when the call failed.

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/api-function-configs/test-run/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
  "requestUrl": "https://help.example.com/refunds",
  "requestMethod": "GET",
  "requestHeaders": {
    "name": "Example",
    "value": "message"
  },
  "requestBody": {
    "name": "Example",
    "value": "message"
  },
  "variables": {
    "name": "Example",
    "value": "message"
  }
}'

const response = await fetch('https://api-prod.usefini.com/v2/api-function-configs/test-run/public', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer fini_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  'id': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3',
  'requestUrl': 'https://help.example.com/refunds',
  'requestMethod': 'GET',
  'requestHeaders': {
    'name': 'Example',
    'value': 'message'
  },
  'requestBody': {
    'name': 'Example',
    'value': 'message'
  },
  'variables': {
    'name': 'Example',
    'value': 'message'
  }
}
  )
});

const data = await response.json();

import requests

response = requests.post(
    "https://api-prod.usefini.com/v2/api-function-configs/test-run/public",
    headers={"Authorization": "Bearer fini_your_api_key", "Content-Type": "application/json"},
    json={
    "id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
    "requestUrl": "https://help.example.com/refunds",
    "requestMethod": "GET",
    "requestHeaders": {
        "name": "Example",
        "value": "message"
    },
    "requestBody": {
        "name": "Example",
        "value": "message"
    },
    "variables": {
        "name": "Example",
        "value": "message"
    }
},
)

data = response.json()

{
  "success": true,
  "response": {
    "plan": "Enterprise",
    "status": "active"
  },
  "savedFields": {
    "plan": "Enterprise",
    "status": "active"
  }
}

Errors

400 Bad Request

The body is malformed, or requestUrl / requestMethod is missing when no id is provided.

401 Unauthorized

The API key is missing, malformed, revoked, or invalid.

403 Forbidden

The API key does not include the write scope required for this route.

⌘I

​Headers

​Body parameters

​Response

​Errors

Headers

Body parameters

Response

Errors