Create a source feed
Saves where a source file is fetched from (URL, FTP, SFTP or a custom extractor). Set
data_extractor and fill only the matching object (url, ftp, sftp or custom): the
other objects are ignored. Nothing is downloaded yet. The source must then be used by a
transformation (set up in the app), otherwise it is deleted automatically after one day.
Returns 402 when the plan's source limit is reached, and 409 when the object matching
data_extractor is missing.
Credentials (password, private_key, headers) are returned as saved in every response.
https://api.wetransform.com/sender/source
user_metadata
array
Free-form name/value pairs attached to the source, whatever its data extractor. On
update, sending the field replaces the whole set; omitting it keeps the current set.
user_metadata[].name
string
Metadata key (max 32 characters).
"type"
user_metadata[].value
string
Free text stored under that key (max 4096 characters), e.g. a category or your own reference. The template and customer listings can filter on it.
"human_resources"
name
string
Display name. Defaults to the file name found in the configuration on creation. Made
unique among your sources by adding a (n) suffix.
data_extractor
string
How the source file is fetched: url, ftp, sftp or custom, each configured by the
object of the same name. Required on creation. On update, send it with its matching object
to replace the configuration, or omit it to keep the current one. Responses show upload
for a source that is a plain uploaded file.
"url"
url
object
URL feed settings: the HTTP request that downloads the file. Required when
data_extractor is url, ignored otherwise.
url.url
string
The URL to which the request is sent.
"https:\/\/example.com"
url.method
string
The HTTP method to use for the request.
Possible values: GET, POST, PUT, DELETE, PATCH
"GET"
url.headers
array
Headers to send along with the request.
Should be an array of hashes, where the key is the header name and the value is the header value.
{
"headers": {
"Authorization": "Bearer 1234567890"
}
}
Can be useful if an Authorization header is required.
url.cookies
array
Cookies to send along with the request.
Should be an array of hashes, where the key is the cookie name and the value is the cookie value.
{
"cookies": {
"session_id": "0987654321"
}
}
Please note that cookies are stateless, we won't change their value based on the response.
url.content_type
string
The content type of the body.
Possible values: application/json, application/xml, text/plain, application/x-www-form-urlencoded, multipart/form-data
"application\/json"
url.body
string
The body of the request, encoded in the right format.
"{\"foo\":\"bar\"}"
ftp
object
FTP feed settings. Required when data_extractor is ftp, ignored otherwise. The
password is returned as saved.
sftp
object
SFTP feed settings. Required when data_extractor is sftp, ignored otherwise. The
password and private key are returned as saved.
custom
object
Custom extractor settings. Required when data_extractor is custom, ignored otherwise.
* are nullable.
{
"user_metadata": [
{
"name": "type",
"value": "human_resources"
}
],
"name": null,
"data_extractor": "url",
"url": {
"url": "https:\/\/example.com",
"method": "GET",
"headers": {
"Authorization": "Bearer 1234567890"
},
"cookies": {
"session_id": "0987654321"
},
"content_type": "application\/json",
"body": "{\"foo\":\"bar\"}"
},
"ftp": null,
"sftp": null,
"custom": null
}success
boolean
Always true on successful responses.
true
payload
object
Payload of the requested resource.
payload.source_id
string
nullable
UUID of the source. Pass it as {sourceId} to the source feed endpoints; transformations
expose it as source_id.
payload.user_metadata
array
Free-form name/value pairs attached to the source, whatever its data extractor. On
update, sending the field replaces the whole set; omitting it keeps the current set.
payload.user_metadata[].name
string
Metadata key (max 32 characters).
"type"
payload.user_metadata[].value
string
nullable
Free text stored under that key (max 4096 characters), e.g. a category or your own reference. The template and customer listings can filter on it.
"human_resources"
payload.name
string
nullable
Display name. Defaults to the file name found in the configuration on creation. Made
unique among your sources by adding a (n) suffix.
payload.data_extractor
string
nullable
How the source file is fetched: url, ftp, sftp or custom, each configured by the
object of the same name. Required on creation. On update, send it with its matching object
to replace the configuration, or omit it to keep the current one. Responses show upload
for a source that is a plain uploaded file.
"url"
payload.url
object
nullable
URL feed settings: the HTTP request that downloads the file. Required when
data_extractor is url, ignored otherwise.
payload.url.url
string
The URL to which the request is sent.
"https:\/\/example.com"
payload.url.method
string
The HTTP method to use for the request.
Possible values: GET, POST, PUT, DELETE, PATCH
"GET"
payload.url.headers
array
Headers to send along with the request.
Should be an array of hashes, where the key is the header name and the value is the header value.
{
"headers": {
"Authorization": "Bearer 1234567890"
}
}
Can be useful if an Authorization header is required.
payload.url.cookies
array
Cookies to send along with the request.
Should be an array of hashes, where the key is the cookie name and the value is the cookie value.
{
"cookies": {
"session_id": "0987654321"
}
}
Please note that cookies are stateless, we won't change their value based on the response.
payload.url.content_type
string
nullable
The content type of the body.
Possible values: application/json, application/xml, text/plain, application/x-www-form-urlencoded, multipart/form-data
"application\/json"
payload.url.body
string
nullable
The body of the request, encoded in the right format.
"{\"foo\":\"bar\"}"
payload.ftp
object
nullable
FTP feed settings. Required when data_extractor is ftp, ignored otherwise. The
password is returned as saved.
payload.sftp
object
nullable
SFTP feed settings. Required when data_extractor is sftp, ignored otherwise. The
password and private key are returned as saved.
payload.custom
object
nullable
Custom extractor settings. Required when data_extractor is custom, ignored otherwise.
product
object
nullable
A product needed.
Not null if user requires to buy a specific product (permission or limitation) in order to access a feature.
product.requirement
string
nullable
Whether the user requested a features s/he doesn't have access to,
or the user needs greater limits.
Possible values: permission, limitation
"permission"
product.permission
object
nullable
The required permission.
You will need to know which permission is needed in order to fill up search filters in the shop.
product.permission.description
string
nullable
A human-understandable name for the permission.
product.permission.name
string
A technical permission name (ex: ORGANISATION_UPDATE_SETTINGS).
Possible values depend on the context, check the domain's metadata endpoint.
"X_SOURCE_FORMAT_XML"
product.limitation_type
string
nullable
The limitation that needs to be increased (ex: number of columns).
product.limitation_needed_value
integer
nullable
The needed resource quantity (if receiver uses 9 columns in a template, this value is 9).
product.limitation_current_value
integer
nullable
The current value of the limitation (if receiver is allowed to use 10 columns, this value is 10).
product.limitation_object
object
nullable
The limitation type in a readable format, for example, "lines per file".
product.ai_feature
string
nullable
The AI feature that could not run, when an AI feature is what hit the limitation
(null for any other product).
Possible values: rule_transformation, rule_template, rule_function, rule_constraint, column_constraints, normalizer, chat_db, doc_assistant, api_doc_assistant, autocorrect, autocorrect_fill, invoice_reader, column_match, value_match, power_populate_with_ai, power_extract_from_pdf, power_extract_from_spreadsheet, agent, column_enrichment, column_constraints_batch, agent_compression, agent_workflow_scaffold, agent_phase_fill, push_json_column_match, value_match_embedding, normalizer_debugger, power_extract_from_text, template_format_custom, power_describe_image, power_background_erase, hosted_image_view, value_match_context
product.message
object
nullable
What stopped, on what, and what it would take — translated and ready to display,
with one wording per AI feature: "Matching the values of column «Couleur» with AI
needs 12 AI credits, and 10 are left."
Null whenever ai_feature is, and on the rare AI exposure that has no subject to
name (the template collection's json_column_match_product covers no single
template). Fall back to the generic call-to-action then.
product.is_cta
boolean
nullable
Whether a Call To Action should be displayed.
It may not be displayed if:
- the limitation is on the membership role
- the limitation is on the customer role
- the user is a sender
debug
array
Debug information.
Contains logs about business logic explaining state of the response payload.
Provided in development & admin modes only.
* are nullable.
{
"success": true,
"payload": {
"source_id": null,
"user_metadata": [
{
"name": "type",
"value": "human_resources"
}
],
"name": null,
"data_extractor": "url",
"url": {
"url": "https:\/\/example.com",
"method": "GET",
"headers": {
"Authorization": "Bearer 1234567890"
},
"cookies": {
"session_id": "0987654321"
},
"content_type": "application\/json",
"body": "{\"foo\":\"bar\"}"
},
"ftp": null,
"sftp": null,
"custom": null
},
"product": {
"requirement": "permission",
"permission": {
"name": "X_SOURCE_FORMAT_XML",
"description": "Can import XML files"
},
"limitation_type": null,
"limitation_needed_value": null,
"limitation_current_value": null,
"limitation_object": null,
"is_cta": false,
"ai_feature": null,
"message": null
},
"debug": []
}The client sent an unexpected request.
It happens if the client sent an invalid JSON payload, or if the JSON payload cannot be mapped to the expected request object.
success
boolean
Always false on error responses.
false
payload
object
Context about the error, if any.
product
object
nullable
A product needed.
Not null if user requires to buy a specific product (permission or limitation) in order to access a feature.
product.requirement
string
nullable
Whether the user requested a features s/he doesn't have access to,
or the user needs greater limits.
Possible values: permission, limitation
"permission"
product.permission
object
nullable
The required permission.
You will need to know which permission is needed in order to fill up search filters in the shop.
product.permission.description
string
nullable
A human-understandable name for the permission.
product.permission.name
string
A technical permission name (ex: ORGANISATION_UPDATE_SETTINGS).
Possible values depend on the context, check the domain's metadata endpoint.
"X_SOURCE_FORMAT_XML"
product.limitation_type
string
nullable
The limitation that needs to be increased (ex: number of columns).
product.limitation_needed_value
integer
nullable
The needed resource quantity (if receiver uses 9 columns in a template, this value is 9).
product.limitation_current_value
integer
nullable
The current value of the limitation (if receiver is allowed to use 10 columns, this value is 10).
product.limitation_object
object
nullable
The limitation type in a readable format, for example, "lines per file".
product.ai_feature
string
nullable
The AI feature that could not run, when an AI feature is what hit the limitation
(null for any other product).
Possible values: rule_transformation, rule_template, rule_function, rule_constraint, column_constraints, normalizer, chat_db, doc_assistant, api_doc_assistant, autocorrect, autocorrect_fill, invoice_reader, column_match, value_match, power_populate_with_ai, power_extract_from_pdf, power_extract_from_spreadsheet, agent, column_enrichment, column_constraints_batch, agent_compression, agent_workflow_scaffold, agent_phase_fill, push_json_column_match, value_match_embedding, normalizer_debugger, power_extract_from_text, template_format_custom, power_describe_image, power_background_erase, hosted_image_view, value_match_context
product.message
object
nullable
What stopped, on what, and what it would take — translated and ready to display,
with one wording per AI feature: "Matching the values of column «Couleur» with AI
needs 12 AI credits, and 10 are left."
Null whenever ai_feature is, and on the rare AI exposure that has no subject to
name (the template collection's json_column_match_product covers no single
template). Fall back to the generic call-to-action then.
product.is_cta
boolean
nullable
Whether a Call To Action should be displayed.
It may not be displayed if:
- the limitation is on the membership role
- the limitation is on the customer role
- the user is a sender
debug
array
Debug information.
Contains logs about business logic explaining state of the response payload.
Provided in development & admin modes only.
* are nullable.
{
"success": false,
"payload": [],
"product": {
"requirement": "permission",
"permission": {
"name": "X_SOURCE_FORMAT_XML",
"description": "Can import XML files"
},
"limitation_type": null,
"limitation_needed_value": null,
"limitation_current_value": null,
"limitation_object": null,
"is_cta": false,
"ai_feature": null,
"message": null
},
"debug": []
}User is well authenticated, but not authorized to access the resource.
It can happen if user is trying to use a feature that s/he didn't pay for, access someone else's resource, etc.
These issues are normally fixed by the frontend, which should render features and resources user has access to.
success
boolean
Always false on error responses.
false
payload
object
Context about the error, if any.
product
object
nullable
A product needed.
Not null if user requires to buy a specific product (permission or limitation) in order to access a feature.
product.requirement
string
nullable
Whether the user requested a features s/he doesn't have access to,
or the user needs greater limits.
Possible values: permission, limitation
"permission"
product.permission
object
nullable
The required permission.
You will need to know which permission is needed in order to fill up search filters in the shop.
product.permission.description
string
nullable
A human-understandable name for the permission.
product.permission.name
string
A technical permission name (ex: ORGANISATION_UPDATE_SETTINGS).
Possible values depend on the context, check the domain's metadata endpoint.
"X_SOURCE_FORMAT_XML"
product.limitation_type
string
nullable
The limitation that needs to be increased (ex: number of columns).
product.limitation_needed_value
integer
nullable
The needed resource quantity (if receiver uses 9 columns in a template, this value is 9).
product.limitation_current_value
integer
nullable
The current value of the limitation (if receiver is allowed to use 10 columns, this value is 10).
product.limitation_object
object
nullable
The limitation type in a readable format, for example, "lines per file".
product.ai_feature
string
nullable
The AI feature that could not run, when an AI feature is what hit the limitation
(null for any other product).
Possible values: rule_transformation, rule_template, rule_function, rule_constraint, column_constraints, normalizer, chat_db, doc_assistant, api_doc_assistant, autocorrect, autocorrect_fill, invoice_reader, column_match, value_match, power_populate_with_ai, power_extract_from_pdf, power_extract_from_spreadsheet, agent, column_enrichment, column_constraints_batch, agent_compression, agent_workflow_scaffold, agent_phase_fill, push_json_column_match, value_match_embedding, normalizer_debugger, power_extract_from_text, template_format_custom, power_describe_image, power_background_erase, hosted_image_view, value_match_context
product.message
object
nullable
What stopped, on what, and what it would take — translated and ready to display,
with one wording per AI feature: "Matching the values of column «Couleur» with AI
needs 12 AI credits, and 10 are left."
Null whenever ai_feature is, and on the rare AI exposure that has no subject to
name (the template collection's json_column_match_product covers no single
template). Fall back to the generic call-to-action then.
product.is_cta
boolean
nullable
Whether a Call To Action should be displayed.
It may not be displayed if:
- the limitation is on the membership role
- the limitation is on the customer role
- the user is a sender
debug
array
Debug information.
Contains logs about business logic explaining state of the response payload.
Provided in development & admin modes only.
* are nullable.
{
"success": false,
"payload": [],
"product": {
"requirement": "permission",
"permission": {
"name": "X_SOURCE_FORMAT_XML",
"description": "Can import XML files"
},
"limitation_type": null,
"limitation_needed_value": null,
"limitation_current_value": null,
"limitation_object": null,
"is_cta": false,
"ai_feature": null,
"message": null
},
"debug": []
}A violation happens when a property value does not respect the expected constraints.
If a user is making a mistake in a form and frontend is not able to detect it (because of the constraint being tied to some business logic for example), the API will return the invalid properties with the right error messages.
Note: examples are hardcoded in english (no access to the translator in a DTO).
success
boolean
Always false on error responses.
false
payload
object
Context about the error, if any.
payload.error
object
Generic message saying the request contains invalid values, translated in the
request locale. The details are in violations.
payload.error.code
string
A translation key for the given message.
"exception.violation"
payload.error.message
string
object
The translated version of the message.
Click on "Example" to get its translated value.
payload.violations
array
One entry per invalid value: the property path (e.g. format.csv.delimiter) and
the reason. Several entries can target the same property.
payload.violations[].property_path
string
Property having an invalid value.
"title"
payload.violations[].invalid_value
nullable
The invalid value.
""
payload.violations[].message
string
An error message describing the violation.
"This value should not be blank"
product
object
nullable
A product needed.
Not null if user requires to buy a specific product (permission or limitation) in order to access a feature.
product.requirement
string
nullable
Whether the user requested a features s/he doesn't have access to,
or the user needs greater limits.
Possible values: permission, limitation
"permission"
product.permission
object
nullable
The required permission.
You will need to know which permission is needed in order to fill up search filters in the shop.
product.permission.description
string
nullable
A human-understandable name for the permission.
product.permission.name
string
A technical permission name (ex: ORGANISATION_UPDATE_SETTINGS).
Possible values depend on the context, check the domain's metadata endpoint.
"X_SOURCE_FORMAT_XML"
product.limitation_type
string
nullable
The limitation that needs to be increased (ex: number of columns).
product.limitation_needed_value
integer
nullable
The needed resource quantity (if receiver uses 9 columns in a template, this value is 9).
product.limitation_current_value
integer
nullable
The current value of the limitation (if receiver is allowed to use 10 columns, this value is 10).
product.limitation_object
object
nullable
The limitation type in a readable format, for example, "lines per file".
product.ai_feature
string
nullable
The AI feature that could not run, when an AI feature is what hit the limitation
(null for any other product).
Possible values: rule_transformation, rule_template, rule_function, rule_constraint, column_constraints, normalizer, chat_db, doc_assistant, api_doc_assistant, autocorrect, autocorrect_fill, invoice_reader, column_match, value_match, power_populate_with_ai, power_extract_from_pdf, power_extract_from_spreadsheet, agent, column_enrichment, column_constraints_batch, agent_compression, agent_workflow_scaffold, agent_phase_fill, push_json_column_match, value_match_embedding, normalizer_debugger, power_extract_from_text, template_format_custom, power_describe_image, power_background_erase, hosted_image_view, value_match_context
product.message
object
nullable
What stopped, on what, and what it would take — translated and ready to display,
with one wording per AI feature: "Matching the values of column «Couleur» with AI
needs 12 AI credits, and 10 are left."
Null whenever ai_feature is, and on the rare AI exposure that has no subject to
name (the template collection's json_column_match_product covers no single
template). Fall back to the generic call-to-action then.
product.is_cta
boolean
nullable
Whether a Call To Action should be displayed.
It may not be displayed if:
- the limitation is on the membership role
- the limitation is on the customer role
- the user is a sender
debug
array
Debug information.
Contains logs about business logic explaining state of the response payload.
Provided in development & admin modes only.
* are nullable.
{
"success": false,
"payload": {
"error": {
"code": "exception.violation",
"message": "The provided payload contains property violations."
},
"violations": [
{
"property_path": "title",
"invalid_value": "",
"message": "This value should not be blank"
},
{
"property_path": "price",
"invalid_value": -5,
"message": "The amount should be greater than 1"
}
]
},
"product": {
"requirement": "permission",
"permission": {
"name": "X_SOURCE_FORMAT_XML",
"description": "Can import XML files"
},
"limitation_type": null,
"limitation_needed_value": null,
"limitation_current_value": null,
"limitation_object": null,
"is_cta": false,
"ai_feature": null,
"message": null
},
"debug": []
}