Image generation API
API base URL: https://api.vooflow.com/v1
The API generates images for projects defined in the application. A project is a template that you customize by modifying field values.
All API calls need to be authenticated using an X-API-KEY header. You can obtain the API key from the project page. Calls without an API key or with an invalid API key return a 404 status code.
Project info
GET /project
Example call:
curl --header "X-API-KEY: eWsXf9TFD_pNaa30VNhtC" https://api.vooflow.com/v1/project
Example response:
{
name: "PROJECT_NAME", projectId: "PROJECT_ID"
}
Fields info
GET /fields
Example call:
curl --header "X-API-KEY: eWsXf9TFD_pNaa30VNhtC" https://api.vooflow.com/v1/fields
Example response:
[
{ key: "field_1", value: "Field 1 label", type: "string", required: true },
{ key: "field_2", value: "Field 2 label", type: "string", required: true }
]
Generate image
POST /image
Example call:
curl --request POST --header "X-API-KEY: eWsXf9TFD_pNaa30VNhtC" --header "Content-Type: application/json" --data '{ field_1: "Text for field_1", field_2: "Text for field_2" }' https://api.vooflow.com/v1/image
Example response:
{
message: "ok"
}
Do note that Project info
and Fields info
endpoints are intended for no-code integrations (Zapier and IFTTT) and are included here for the sake of completeness. As a developer you should only focus on the Generate image
endpoint.