curl --request POST \
--url 'https://api-prod.usefini.com/v2/api-function-configs/public' \
--header 'Authorization: Bearer fini_your_api_key' \
--header 'Content-Type: application/json' \
--data '{
"name": "Refund policy",
"requestUrl": "https://help.example.com/refunds",
"requestMethod": "GET",
"toolId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"stepNumber": 0,
"requestHeaders": {
"name": "Example",
"value": "message"
},
"requestBody": {
"name": "Example",
"value": "message"
},
"responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
}'
const response = await fetch('https://api-prod.usefini.com/v2/api-function-configs/public', {
method: 'POST',
headers: {
Authorization: 'Bearer fini_your_api_key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
'name': 'Refund policy',
'requestUrl': 'https://help.example.com/refunds',
'requestMethod': 'GET',
'toolId': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3',
'stepNumber': 0,
'requestHeaders': {
'name': 'Example',
'value': 'message'
},
'requestBody': {
'name': 'Example',
'value': 'message'
},
'responseMapping': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3',
'id': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3'
}
)
});
const data = await response.json();
import requests
response = requests.post(
"https://api-prod.usefini.com/v2/api-function-configs/public",
headers={"Authorization": "Bearer fini_your_api_key", "Content-Type": "application/json"},
json={
"name": "Refund policy",
"requestUrl": "https://help.example.com/refunds",
"requestMethod": "GET",
"toolId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"stepNumber": 0,
"requestHeaders": {
"name": "Example",
"value": "message"
},
"requestBody": {
"name": "Example",
"value": "message"
},
"responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
},
)
data = response.json()
{
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"name": "Lookup customer",
"method": "GET",
"url": "https://api.example.com/customers/{customerId}",
"headers": {
"Authorization": "Bearer ${apiToken}"
},
"saveFromResponse": {
"plan": "customer.plan",
"status": "customer.status"
},
"createdAt": "2026-07-28T08:55:32.000Z",
"updatedAt": "2026-07-28T09:10:18.000Z"
}
External API calls
Create external API call
Create an external API call step for an action or attribute.
POST
/
v2
/
api-function-configs
/
public
curl --request POST \
--url 'https://api-prod.usefini.com/v2/api-function-configs/public' \
--header 'Authorization: Bearer fini_your_api_key' \
--header 'Content-Type: application/json' \
--data '{
"name": "Refund policy",
"requestUrl": "https://help.example.com/refunds",
"requestMethod": "GET",
"toolId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"stepNumber": 0,
"requestHeaders": {
"name": "Example",
"value": "message"
},
"requestBody": {
"name": "Example",
"value": "message"
},
"responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
}'
const response = await fetch('https://api-prod.usefini.com/v2/api-function-configs/public', {
method: 'POST',
headers: {
Authorization: 'Bearer fini_your_api_key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
'name': 'Refund policy',
'requestUrl': 'https://help.example.com/refunds',
'requestMethod': 'GET',
'toolId': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3',
'stepNumber': 0,
'requestHeaders': {
'name': 'Example',
'value': 'message'
},
'requestBody': {
'name': 'Example',
'value': 'message'
},
'responseMapping': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3',
'id': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3'
}
)
});
const data = await response.json();
import requests
response = requests.post(
"https://api-prod.usefini.com/v2/api-function-configs/public",
headers={"Authorization": "Bearer fini_your_api_key", "Content-Type": "application/json"},
json={
"name": "Refund policy",
"requestUrl": "https://help.example.com/refunds",
"requestMethod": "GET",
"toolId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"stepNumber": 0,
"requestHeaders": {
"name": "Example",
"value": "message"
},
"requestBody": {
"name": "Example",
"value": "message"
},
"responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
},
)
data = response.json()
{
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"name": "Lookup customer",
"method": "GET",
"url": "https://api.example.com/customers/{customerId}",
"headers": {
"Authorization": "Bearer ${apiToken}"
},
"saveFromResponse": {
"plan": "customer.plan",
"status": "customer.status"
},
"createdAt": "2026-07-28T08:55:32.000Z",
"updatedAt": "2026-07-28T09:10:18.000Z"
}
Creates one external API call for an action or attribute. The wire-format object is still called
Data Step. Steps run in stepNumber order, each feeding its extracted output into the next.
Headers
Bearer token containing your Fini workspace API key. Format:
Bearer fini_... The key needs write scope.Body parameters
Request URL. Supports
${fieldName} interpolation from inputs and ${stepId.responseMappingKey} interpolation from earlier external API calls. {{placeholder}} syntax is not supported.ID of the action or attribute this step belongs to. Set it so the step runs as part of that chain.
Request headers. To store a value as sensitive, send
{ "hide": true, "value": "<secret>" }. See Sensitive values and masking.Map of output keys to response paths. See ResponseMapping.
Response
Returns the createdData Step with sensitive values masked.
curl --request POST \
--url 'https://api-prod.usefini.com/v2/api-function-configs/public' \
--header 'Authorization: Bearer fini_your_api_key' \
--header 'Content-Type: application/json' \
--data '{
"name": "Refund policy",
"requestUrl": "https://help.example.com/refunds",
"requestMethod": "GET",
"toolId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"stepNumber": 0,
"requestHeaders": {
"name": "Example",
"value": "message"
},
"requestBody": {
"name": "Example",
"value": "message"
},
"responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
}'
const response = await fetch('https://api-prod.usefini.com/v2/api-function-configs/public', {
method: 'POST',
headers: {
Authorization: 'Bearer fini_your_api_key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
'name': 'Refund policy',
'requestUrl': 'https://help.example.com/refunds',
'requestMethod': 'GET',
'toolId': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3',
'stepNumber': 0,
'requestHeaders': {
'name': 'Example',
'value': 'message'
},
'requestBody': {
'name': 'Example',
'value': 'message'
},
'responseMapping': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3',
'id': '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3'
}
)
});
const data = await response.json();
import requests
response = requests.post(
"https://api-prod.usefini.com/v2/api-function-configs/public",
headers={"Authorization": "Bearer fini_your_api_key", "Content-Type": "application/json"},
json={
"name": "Refund policy",
"requestUrl": "https://help.example.com/refunds",
"requestMethod": "GET",
"toolId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"stepNumber": 0,
"requestHeaders": {
"name": "Example",
"value": "message"
},
"requestBody": {
"name": "Example",
"value": "message"
},
"responseMapping": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
},
)
data = response.json()
{
"id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
"name": "Lookup customer",
"method": "GET",
"url": "https://api.example.com/customers/{customerId}",
"headers": {
"Authorization": "Bearer ${apiToken}"
},
"saveFromResponse": {
"plan": "customer.plan",
"status": "customer.status"
},
"createdAt": "2026-07-28T08:55:32.000Z",
"updatedAt": "2026-07-28T09:10:18.000Z"
}
Errors
400 Bad Request
400 Bad Request
The body is malformed or missing a required field.
401 Unauthorized
401 Unauthorized
The API key is missing, malformed, revoked, or invalid.
403 Forbidden
403 Forbidden
The API key does not include the
write scope required for this route.500 Internal Server Error
500 Internal Server Error
Fini failed while creating the Data Step in storage.
Was this page helpful?

