Skip to main content
GET
/
api
/
provider
/
projects
/
:projectId
/
mapping-fields
Get Project Mapping Fields
curl --request GET \
  --url https://api.techforgeinnovate.com/api/provider/projects/:projectId/mapping-fields \
  --header 'x-api-key: <api-key>'
{
  "message": "<string>",
  "data.projectId": "<string>",
  "data.projectName": "<string>",
  "data.projectType": "<string>",
  "data.fields": {},
  "data.fetchedAt": "<string>"
}

​
Get Project Mapping Fields

Returns the field map extracted from a project’s stored instructions. This is the endpoint to call before building the values object for POST /jobs/v2.

​
Path parameters

​
projectId
string
required
Project UUID returned by GET /api/provider/projects/active.

​
Example request

curl "https://api.techforgeinnovate.com/api/provider/projects/468ea7a0-66e1-4357-a760-236e54167f3e/mapping-fields" \
  -H "x-api-key: $TFI_API_KEY"

​
Response

​
message
string
required
Returns Success when the project exists and is accessible.
​
data.projectId
string
required
Project UUID.
​
data.projectName
string
required
Human-readable project name.
​
data.projectType
string
required
Project workflow type.
​
data.fields
object
required
Map keyed by field identifier. Each field contains a label and an optional instructionType.
​
data.fetchedAt
string
required
ISO timestamp showing when the field map was generated.
Example response: 
{
  "message": "Success",
  "data": {
    "projectId": "468ea7a0-66e1-4357-a760-236e54167f3e",
    "projectName": "Spring campaign avatar video",
    "projectType": "ai_talking_video",
    "fields": {
      "headline": {
        "label": "Headline",
        "instructionType": "text"
      },
      "voiceover": {
        "label": "Voiceover",
        "instructionType": "audio"
      },
      "avatar": {
        "label": "Avatar",
        "instructionType": "image"
      }
    },
    "fetchedAt": "2026-04-16T12:00:00.000Z"
  }
}

​
Status codes

  • 200 OK when the project is found
  • 401 Unauthorized when the key is missing or invalid
  • 404 Not Found when the project does not belong to the authenticated account or no longer exists