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

# Get Build Info

> Retrieve the active build for an app and workspace. Returns the buildId you need to start a process via REST.

<Tip>
  Looking for end-to-end guidance on calling FlowX from your own app? See [Consuming FlowX from external apps](/5.9/docs/platform-deep-dive/integrations/consuming-flowx-from-external-apps).
</Tip>

## Base URL

* Always prepend the endpoint with the correct Base URL.
* For different environments (like staging or production), switch the base URL accordingly.

<Info>
  This endpoint is only accessible via the admin environment. Ensure that you are using the correct admin base URL when making requests.
</Info>

## Authorization

<ParamField header="Authorization" type="string" required={true} placeholder="Bearer <token>">
  Bearer authentication header of the form Bearer `<token>`, where `<token>` is your auth token.
</ParamField>

## Request headers

<ParamField header="Authorization" type="string" required={true}>
  Bearer token required for authentication. Format: `Bearer <token>`.
</ParamField>

<ParamField header="Accept" type="string" placeholder="application/json, text/plain, */*">
  Specifies the media types that are acceptable for the response. Defaults to accepting JSON and plain text responses.
</ParamField>

<ParamField header="Accept-Encoding" type="string" placeholder="gzip, deflate, br, zstd">
  Indicates supported content encoding algorithms for the response.
</ParamField>

<ParamField header="Accept-Language" type="string" placeholder="en-GB,en-US;q=0.9,en;q=0.8">
  Specifies language preferences for the response.
</ParamField>

## Path Parameters

<Info>
  **Need help finding the Application ID or Workspace ID?** See the [Finding Identifiers and Parameters](../../platform-deep-dive/integrations/finding-identifiers-and-parameters) guide for detailed instructions on where to locate these values in FlowX Designer.
</Info>

<ParamField path="workspaceId" type="string" required placeholder="12345678-1234-1234-1234-123456789012">
  The unique identifier of the workspace that contains the application. This parameter is used to search for the appId within the specified workspace. This value is populated by the Configurator in the container app and varies across different environments (e.g., production, development, UAT).
</ParamField>

<ParamField path="appId" type="string" required placeholder="dbe0ab87-539b-4015-962d-6e73226b9e58">
  The unique identifier of the application whose build information is being retrieved.
</ParamField>

<RequestExample>
  ```bash theme={"system"}
  curl --request GET \
    --url https://admin.devmain.flowxai.dev/rtm/api/runtime/wks/{workspaceId}/app/{appId}/build/info \
    --header "Authorization: Bearer <token>" \
    --header "Flowx-Platform: web"
  ```
</RequestExample>

## Response Fields

<ResponseField name="workspaceId" type="string" example="12341234-1234-1234-1234123412341234">
  The unique identifier of the workspace that contains the application.
</ResponseField>

<ResponseField name="buildId" type="string" example="11111111-1111-1111-1111-111111111111">
  The unique identifier of the build entity.
</ResponseField>

<ResponseField name="applicationId" type="string" example="4ffeeb22-e84a-400f-9e07-b305ab0b4241">
  The ID of the application associated with the build.
</ResponseField>

<ResponseField name="buildSettings" type="object">
  Contains configuration settings related to the build.

  <Expandable title="Properties">
    <ResponseField name="applicationVersionId" type="string" example="99f24e3f-e331-48ad-a503-2cc1cee5fb95">
      The version ID of the application associated with the build.
    </ResponseField>

    <ResponseField name="platforms" type="string" example="OMNICHANNEL">
      Indicates the supported platforms for the build (e.g., `OMNICHANNEL`).
    </ResponseField>

    <ResponseField name="themeId" type="string" example="12345678-1234-1234-1234-123456789012">
      The ID of the theme applied to the build.
    </ResponseField>

    <ResponseField name="dateDisplayFormat" type="object">
      Defines the format used for displaying dates.

      <Expandable title="Properties">
        <ResponseField name="format" type="string" example="short">
          Specifies the date format style (e.g., `short`).
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="numberDisplayFormat" type="object">
      Configuration for displaying numerical values, including decimal precision.

      <Expandable title="Properties">
        <ResponseField name="minDecimals" type="integer" example="1">
          The minimum number of decimal places to display in numerical values.
        </ResponseField>

        <ResponseField name="maxDecimals" type="integer" example="2">
          The maximum number of decimal places to display in numerical values.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="currencyDisplayFormat" type="object">
      Defines the format used for displaying currency.

      <Expandable title="Properties">
        <ResponseField name="format" type="string" example="isoCode">
          Specifies the format for displaying currency (e.g., `isoCode`).
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="defaultLanguageCode" type="string" example="en">
      The default language code for the build (e.g., `en` for English).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json Success theme={"system"}
  {
    "workspaceId": "12341234-1234-1234-1234123412341234",
    "buildId": "11111111-1111-1111-1111-111111111111",
    "applicationId": "4ffeeb22-e84a-400f-9e07-b305ab0b4241",
    "buildSettings": {
      "applicationVersionId": "99f24e3f-e331-48ad-a503-2cc1cee5fb95",
      "platforms": "OMNICHANNEL",
      "themeId": "12345678-1234-1234-1234-123456789012",
      "dateDisplayFormat": {
        "format": "short"
      },
      "numberDisplayFormat": {
        "minDecimals": 1,
        "maxDecimals": 2
      },
      "currencyDisplayFormat": {
        "format": "isoCode"
      },
      "defaultLanguageCode": "en"
    }
  }
  ```
</ResponseExample>

## Response Headers

<ResponseField name="Access-Control-Allow-Credentials" type="boolean" example="true">
  Indicates whether the response can be exposed when credentials are present. Example: `true`.
</ResponseField>

<ResponseField name="Access-Control-Allow-Headers" type="string" example="DNT, Keep-Alive, User-Agent, X-Requested-With, If-Modified-Since, Cache-Control, Content-Type, Range, Authorization, Flowx-Platform">
  Lists the allowed headers in the actual request.
</ResponseField>

<ResponseField name="Access-Control-Allow-Methods" type="string" example="GET, PUT, POST, DELETE, PATCH">
  Specifies the allowed HTTP methods.
</ResponseField>

<ResponseField name="Access-Control-Allow-Origin" type="string" example="https://demo-angular.devmain.flowxai.dev">
  Indicates the allowed origin for cross-origin requests.
</ResponseField>

<ResponseField name="Content-Encoding" type="string" example="gzip">
  Specifies the encoding used to compress the response.
</ResponseField>

<ResponseField name="Content-Type" type="string" example="application/json">
  Indicates the media type of the response content.
</ResponseField>

<ResponseField name="Strict-Transport-Security" type="string" example="max-age=31536000; includeSubDomains">
  Enforces secure (HTTPS) connections to the server.
</ResponseField>

<ResponseField name="Vary" type="string" example="Accept-Encoding">
  Specifies that the response may vary based on the `Accept-Encoding` request header.
</ResponseField>

<ResponseField name="X-Content-Type-Options" type="string" example="nosniff">
  Prevents the browser from MIME-sniffing a response away from the declared `Content-Type`.
</ResponseField>

<ResponseField name="X-XSS-Protection" type="string" example="0">
  Controls the cross-site scripting (XSS) filter. Example: `0` (disabled).
</ResponseField>
