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

# Read an application's proposed setup contract

> Read the setup Ankra proposed for this application before anything is deployed: the detected stack, whether a database was generated, and the deploy option contract of record. The contract and database each carry a three-valued status - a proposal Ankra could not read answers "unknown", never an empty option list.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /org/applications/{application_id}/setup-contract
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
paths:
  /org/applications/{application_id}/setup-contract:
    get:
      tags:
        - Applications API
      summary: Read an application's proposed setup contract
      description: >-
        Read the setup Ankra proposed for this application before anything is
        deployed: the detected stack, whether a database was generated, and the
        deploy option contract of record. The contract and database each carry a
        three-valued status - a proposal Ankra could not read answers "unknown",
        never an empty option list.
      operationId: get_application_setup_contract
      parameters:
        - in: path
          name: application_id
          required: true
          schema:
            title: Application Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSetupProposal'
          description: Successful Response
        '401':
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: Not found ("Application not found")
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    ApplicationSetupProposal:
      description: >-
        The generated setup as recorded on the application: what Ankra detected,
        what it proposed, and what of it is negotiable. negotiable_options lists
        the option names a revision may change, so a caller never has to guess
        and a refusal is never the first thing the user learns.
      properties:
        application_id:
          title: Application Id
          type: string
        name:
          title: Name
          type: string
        analysis_status:
          title: Analysis Status
          type: string
        detected_language:
          title: Detected Language
          type: string
        detected_framework:
          title: Detected Framework
          type: string
        pull_request_url:
          title: Pull Request Url
          type: string
        setup_branch:
          title: Setup Branch
          type: string
        contract:
          $ref: '#/components/schemas/ApplicationSetupContract'
        database:
          $ref: '#/components/schemas/ApplicationSetupDatabase'
        negotiable_options:
          items:
            type: string
          title: Negotiable Options
          type: array
      required:
        - application_id
        - name
        - analysis_status
        - contract
        - database
        - negotiable_options
      title: Application Setup Proposal
      type: object
    DemoDetailError:
      description: >-
        The FastAPI-style detail envelope the demo routes use for
        400/403/404/409/502 responses.
      properties:
        detail:
          type: string
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ApplicationSetupContract:
      description: >-
        The deploy option contract of record. options is populated only when
        status is "recorded"; on "absent" and "unknown" it is null and reason
        says which. An application whose contract Ankra cannot read is not an
        application without a contract, so the two must not be rendered the same
        way.
      properties:
        status:
          $ref: '#/components/schemas/ApplicationSetupArtifactStatus'
        path:
          title: Path
          type: string
        options:
          anyOf:
            - items:
                $ref: '#/components/schemas/ApplicationSetupOption'
              type: array
            - type: 'null'
          title: Options
        reason:
          title: Reason
          type: string
      required:
        - status
        - path
        - options
      title: Application Setup Contract
      type: object
    ApplicationSetupDatabase:
      description: >-
        The database the proposal carries, read off the recorded manifests
        rather than off the detection that produced them.
        engine/operator/manifest_path are set only when status is "recorded".
      properties:
        status:
          $ref: '#/components/schemas/ApplicationSetupArtifactStatus'
        engine:
          title: Engine
          type: string
        operator:
          title: Operator
          type: string
        manifest_path:
          title: Manifest Path
          type: string
        reason:
          title: Reason
          type: string
      required:
        - status
      title: Application Setup Database
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    ApplicationSetupArtifactStatus:
      description: >-
        Which of the three states a recorded setup artifact is in. "absent"
        means Ankra successfully read the record and it genuinely does not
        contain the artifact; "unknown" means Ankra could not tell - the
        analysis has not completed, nothing was recorded, or what was recorded
        could not be read. They are separate values because a client that
        renders "unknown" as "no options" tells the user Ankra has nothing to
        offer when in fact it could not work out what applies.
      enum:
        - recorded
        - absent
        - unknown
      title: Application Setup Artifact Status
      type: string
    ApplicationSetupOption:
      description: >-
        One deploy option declared by the application's .ankra/ankra.yaml. The
        deploy form renders these and the deploy endpoint validates submitted
        inputs against them.
      properties:
        name:
          title: Name
          type: string
        type:
          title: Type
          type: string
        required:
          title: Required
          type: boolean
        default:
          anyOf:
            - type: string
            - type: 'null'
          title: Default
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
      required:
        - name
        - type
        - required
        - default
        - description
      title: Application Setup Option
      type: object

````