> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Run a Composition

> Runs a query on a single composition and returns matching results.

**Required ACL:** `search`

## Usage

<CodeGroup>
  ```cs C# theme={"system"}
  // Initialize the client
  var client = new CompositionClient(
    new CompositionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
  );

  // Call the API
  var response = await client.SearchAsync<Hit>(
    "foo",
    new RequestBody
    {
      Params = new Params { Query = "batman" },
      FeedsOrder = new List<string> { "feed-movies", "feed-comics" },
    }
  );

  // print the response
  Console.WriteLine(response);
  ```

  ```dart Dart theme={"system"}
  // Initialize the client
  final client = CompositionClient(
      appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');

  // Call the API
  final response = await client.search(
    compositionID: "foo",
    requestBody: RequestBody(
      params: Params(
        query: "batman",
      ),
      feedsOrder: [
        "feed-movies",
        "feed-comics",
      ],
    ),
  );

  // print the response
  print(response);
  ```

  ```go Go theme={"system"}
  // Initialize the client
  client, err := composition.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
  if err != nil {
    // The client can fail to initialize if you pass an invalid parameter.
    panic(err)
  }

  // Call the API
  response, err := client.Search(client.NewApiSearchRequest(
    "foo",
    composition.NewEmptyRequestBody().SetParams(
      composition.NewEmptyParams().SetQuery("batman")).SetFeedsOrder(
      []string{"feed-movies", "feed-comics"})))
  if err != nil {
    // handle the eventual error
    panic(err)
  }


  // print the response
  print(response)
  ```

  ```java Java theme={"system"}
  // Initialize the client
  CompositionClient client = new CompositionClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");

  // Call the API
  SearchResponse response = client.search(
    "foo",
    new RequestBody().setParams(new Params().setQuery("batman")).setFeedsOrder(Arrays.asList("feed-movies", "feed-comics")),
    Hit.class
  );

  // print the response
  System.out.println(response);
  ```

  ```js JavaScript theme={"system"}
  // Initialize the client
  const client = compositionClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

  // Call the API
  const response = await client.search({
    compositionID: 'foo',
    requestBody: { params: { query: 'batman' }, feedsOrder: ['feed-movies', 'feed-comics'] },
  });


  // print the response
  console.log(response);
  ```

  ```kotlin Kotlin theme={"system"}
  // Initialize the client
  val client = CompositionClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

  // Call the API
  var response =
    client.search(
      compositionID = "foo",
      requestBody =
        RequestBody(
          params = Params(query = "batman"),
          feedsOrder = listOf("feed-movies", "feed-comics"),
        ),
    )


  // print the response
  println(response)
  ```

  ```php PHP theme={"system"}
  // Initialize the client
  $client = CompositionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

  // Call the API
  $response = $client->search(
      'foo',
      ['params' => ['query' => 'batman',
      ],
          'feedsOrder' => [
              'feed-movies',

              'feed-comics',
          ],
      ],
  );


  // print the response
  var_dump($response);
  ```

  ```python Python theme={"system"}
  # Initialize the client
  # In an asynchronous context, you can use CompositionClient instead, which exposes the exact same methods.
  client = CompositionClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

  # Call the API
  response = client.search(
      composition_id="foo",
      request_body={
          "params": {
              "query": "batman",
          },
          "feedsOrder": [
              "feed-movies",
              "feed-comics",
          ],
      },
  )


  # print the response
  print(response)
  ```

  ```ruby Ruby theme={"system"}
  # Initialize the client
  client = Algolia::CompositionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

  # Call the API
  response = client.search(
    "foo",
    Algolia::Composition::RequestBody.new(
      params: Algolia::Composition::Params.new(query: "batman"),
      feeds_order: ["feed-movies", "feed-comics"]
    )
  )


  # print the response
  puts(response)
  ```

  ```scala Scala theme={"system"}
  // Initialize the client
  val client = CompositionClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

  // Call the API
  val response = Await.result(
    client.search(
      compositionID = "foo",
      requestBody = RequestBody(
        params = Some(
          Params(
            query = Some("batman")
          )
        ),
        feedsOrder = Some(Seq("feed-movies", "feed-comics"))
      )
    ),
    Duration(100, "sec")
  )

  // print the response
  println(response)
  ```

  ```swift Swift theme={"system"}
  // Initialize the client
  let client = try CompositionClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

  // Call the API
  let response: CompositionSearchResponse<CompositionHit> = try await client.search(
      compositionID: "foo",
      requestBody: RequestBody(
          params: CompositionParams(query: "batman"),
          feedsOrder: ["feed-movies", "feed-comics"]
      )
  )

  // print the response
  print(response)
  ```
</CodeGroup>

<Card icon="folder-code" horizontal="true" title="See the full API reference" arrow="true" href="/doc/rest-api/composition/search">
  For more details about input parameters
  and response fields.
</Card>
