curl --request POST \
--url https://data.us.algolia.com/1/transformations/search \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
--data '
{
"transformationIDs": [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f"
]
}
'// Initialize the client
var client = new IngestionClient(
new IngestionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
);
// Call the API
var response = await client.SearchTransformationsAsync(
new TransformationSearch
{
TransformationIDs = new List<string>
{
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
},
}
);
// print the response
Console.WriteLine(response);// Initialize the client
final client = IngestionClient(
appId: 'ALGOLIA_APPLICATION_ID',
apiKey: 'ALGOLIA_API_KEY',
region: 'ALGOLIA_APPLICATION_REGION');
// Call the API
final response = await client.searchTransformations(
transformationSearch: TransformationSearch(
transformationIDs: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
],
),
);
// print the response
print(response);// Initialize the client with your application region, eg. ingestion.ALGOLIA_APPLICATION_REGION
client, err := ingestion.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", ingestion.US)
if err != nil {
// The client can fail to initialize if you pass an invalid parameter.
panic(err)
}
// Call the API
response, err := client.SearchTransformations(client.NewApiSearchTransformationsRequest(
ingestion.NewEmptyTransformationSearch().SetTransformationIDs(
[]string{"6c02aeb1-775e-418e-870b-1faccd4b2c0f", "947ac9c4-7e58-4c87-b1e7-14a68e99699a", "76ab4c2a-ce17-496f-b7a6-506dc59ee498"})))
if err != nil {
// handle the eventual error
panic(err)
}
// print the response
print(response)// Initialize the client
IngestionClient client = new IngestionClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION");
// Call the API
List response = client.searchTransformations(
new TransformationSearch().setTransformationIDs(
Arrays.asList(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
)
)
);
// print the response
System.out.println(response);// Initialize the client
// Replace 'us' with your Algolia Application Region
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initIngestion({ region: 'us' });
// Call the API
const response = await client.searchTransformations({
transformationIDs: [
'6c02aeb1-775e-418e-870b-1faccd4b2c0f',
'947ac9c4-7e58-4c87-b1e7-14a68e99699a',
'76ab4c2a-ce17-496f-b7a6-506dc59ee498',
],
});
// print the response
console.log(response);// Initialize the client
val client =
IngestionClient(
appId = "ALGOLIA_APPLICATION_ID",
apiKey = "ALGOLIA_API_KEY",
region = "ALGOLIA_APPLICATION_REGION",
)
// Call the API
var response =
client.searchTransformations(
transformationSearch =
TransformationSearch(
transformationIDs =
listOf(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
)
)
)
// print the response
println(response)// Initialize the client
$client = IngestionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');
// Call the API
$response = $client->searchTransformations(
['transformationIDs' => [
'6c02aeb1-775e-418e-870b-1faccd4b2c0f',
'947ac9c4-7e58-4c87-b1e7-14a68e99699a',
'76ab4c2a-ce17-496f-b7a6-506dc59ee498',
],
],
);
// print the response
var_dump($response);# Initialize the client
# In an asynchronous context, you can use IngestionClient instead, which exposes the exact same methods.
client = IngestionClientSync(
"ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
)
# Call the API
response = client.search_transformations(
transformation_search={
"transformationIDs": [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
],
},
)
# print the response
print(response)# Initialize the client
client = Algolia::IngestionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
# Call the API
response = client.search_transformations(
Algolia::Ingestion::TransformationSearch.new(
transformation_ids: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
]
)
)
# print the response
puts(response)// Initialize the client
val client = IngestionClient(
appId = "ALGOLIA_APPLICATION_ID",
apiKey = "ALGOLIA_API_KEY",
region = "ALGOLIA_APPLICATION_REGION"
)
// Call the API
val response = Await.result(
client.searchTransformations(
transformationSearch = TransformationSearch(
transformationIDs = Seq(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
)
)
),
Duration(100, "sec")
)
// print the response
println(response)// Initialize the client
let client = try IngestionClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY", region: .us)
// Call the API
let response = try await client
.searchTransformations(transformationSearch: TransformationSearch(transformationIDs: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
]))
// print the response
print(response)[
{
"code": "<string>",
"createdAt": "<string>",
"name": "<string>",
"transformationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"updatedAt": "<string>",
"authenticationIDs": [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f"
],
"description": "<string>",
"input": {
"code": "<string>"
},
"owner": "<string>"
}
]{
"message": "Invalid Application-Id or API-Key"
}Search for transformations
Searches for transformations.
curl --request POST \
--url https://data.us.algolia.com/1/transformations/search \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
--data '
{
"transformationIDs": [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f"
]
}
'// Initialize the client
var client = new IngestionClient(
new IngestionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
);
// Call the API
var response = await client.SearchTransformationsAsync(
new TransformationSearch
{
TransformationIDs = new List<string>
{
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
},
}
);
// print the response
Console.WriteLine(response);// Initialize the client
final client = IngestionClient(
appId: 'ALGOLIA_APPLICATION_ID',
apiKey: 'ALGOLIA_API_KEY',
region: 'ALGOLIA_APPLICATION_REGION');
// Call the API
final response = await client.searchTransformations(
transformationSearch: TransformationSearch(
transformationIDs: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
],
),
);
// print the response
print(response);// Initialize the client with your application region, eg. ingestion.ALGOLIA_APPLICATION_REGION
client, err := ingestion.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", ingestion.US)
if err != nil {
// The client can fail to initialize if you pass an invalid parameter.
panic(err)
}
// Call the API
response, err := client.SearchTransformations(client.NewApiSearchTransformationsRequest(
ingestion.NewEmptyTransformationSearch().SetTransformationIDs(
[]string{"6c02aeb1-775e-418e-870b-1faccd4b2c0f", "947ac9c4-7e58-4c87-b1e7-14a68e99699a", "76ab4c2a-ce17-496f-b7a6-506dc59ee498"})))
if err != nil {
// handle the eventual error
panic(err)
}
// print the response
print(response)// Initialize the client
IngestionClient client = new IngestionClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION");
// Call the API
List response = client.searchTransformations(
new TransformationSearch().setTransformationIDs(
Arrays.asList(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
)
)
);
// print the response
System.out.println(response);// Initialize the client
// Replace 'us' with your Algolia Application Region
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initIngestion({ region: 'us' });
// Call the API
const response = await client.searchTransformations({
transformationIDs: [
'6c02aeb1-775e-418e-870b-1faccd4b2c0f',
'947ac9c4-7e58-4c87-b1e7-14a68e99699a',
'76ab4c2a-ce17-496f-b7a6-506dc59ee498',
],
});
// print the response
console.log(response);// Initialize the client
val client =
IngestionClient(
appId = "ALGOLIA_APPLICATION_ID",
apiKey = "ALGOLIA_API_KEY",
region = "ALGOLIA_APPLICATION_REGION",
)
// Call the API
var response =
client.searchTransformations(
transformationSearch =
TransformationSearch(
transformationIDs =
listOf(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
)
)
)
// print the response
println(response)// Initialize the client
$client = IngestionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');
// Call the API
$response = $client->searchTransformations(
['transformationIDs' => [
'6c02aeb1-775e-418e-870b-1faccd4b2c0f',
'947ac9c4-7e58-4c87-b1e7-14a68e99699a',
'76ab4c2a-ce17-496f-b7a6-506dc59ee498',
],
],
);
// print the response
var_dump($response);# Initialize the client
# In an asynchronous context, you can use IngestionClient instead, which exposes the exact same methods.
client = IngestionClientSync(
"ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
)
# Call the API
response = client.search_transformations(
transformation_search={
"transformationIDs": [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
],
},
)
# print the response
print(response)# Initialize the client
client = Algolia::IngestionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
# Call the API
response = client.search_transformations(
Algolia::Ingestion::TransformationSearch.new(
transformation_ids: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
]
)
)
# print the response
puts(response)// Initialize the client
val client = IngestionClient(
appId = "ALGOLIA_APPLICATION_ID",
apiKey = "ALGOLIA_API_KEY",
region = "ALGOLIA_APPLICATION_REGION"
)
// Call the API
val response = Await.result(
client.searchTransformations(
transformationSearch = TransformationSearch(
transformationIDs = Seq(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
)
)
),
Duration(100, "sec")
)
// print the response
println(response)// Initialize the client
let client = try IngestionClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY", region: .us)
// Call the API
let response = try await client
.searchTransformations(transformationSearch: TransformationSearch(transformationIDs: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
]))
// print the response
print(response)[
{
"code": "<string>",
"createdAt": "<string>",
"name": "<string>",
"transformationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"updatedAt": "<string>",
"authenticationIDs": [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f"
],
"description": "<string>",
"input": {
"code": "<string>"
},
"owner": "<string>"
}
]{
"message": "Invalid Application-Id or API-Key"
}addObject, deleteIndex, editSettingsAuthorizations
Your Algolia application ID.
Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.
Body
Universally unique identifier (UUID) of a transformation.
Response
OK
It is deprecated. Use the input field with proper type instead to specify the transformation code.
Date and time when the resource was created, in RFC 3339 format.
The uniquely identified name of your transformation.
Universally unique identifier (UUID) of a transformation.
"6c02aeb1-775e-418e-870b-1faccd4b2c0f"
Date and time when the resource was last updated, in RFC 3339 format.
The authentications associated with the current transformation.
Universally unique identifier (UUID) of an authentication resource.
A descriptive name for your transformation of what it does.
The input for the transformation, which can be either code or a no-code configuration.
- Code
- No-code
Show child attributes
Show child attributes
Owner of the resource.
The type of transformation, which can be either 'code' or 'noCode'.
code, noCode Was this page helpful?