Gadget core API

openapi: 3.1.0
info:
  title: Gadget core API
  version: '2026-10-29'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-29: 7 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Gadget has published no machine-readable contract that the pipeline
    could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 11
    documentation: 12
    pages-with-code: 14
    pages-read: 17
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-29'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.gadget.dev/guides/development-tools/load-testing
  - https://docs.gadget.dev/guides/frontend/external-frontends
  - https://docs.gadget.dev/guides/models/storing-files
  - https://docs.gadget.dev/guides/tutorials/bigcommerce/size-charts
  - https://docs.gadget.dev/guides/tutorials/middleware
  - https://docs.gadget.dev/reference/gadget-server
  x-docs-section: core
paths:
  /admin/api/2026-04/graphql.json:
    post:
      operationId: post_admin_api_2026_04_graphql_json
      tags:
      - Admin
      summary: POST /admin/api/2026-04/graphql.json
      x-source: https://docs.gadget.dev/reference/gadget-server
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAdminApi202604GraphqlJsonRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAdminApi202604GraphqlJsonResponse'
      x-evidence:
        kind: code-example
        language: javascript
        snippet: "fetch(`https://${shopDomain}/admin/api/2026-04/graphql.json`, {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\"\
          ,\n \"X-Shopify-Access-Token\": accessToken,\n },\n body: JSON.stringify({ query: \"{ shop {name} }\" })"
  /api/files/upload-target:
    get:
      operationId: get_api_files_upload_target
      tags:
      - Api
      summary: GET /api/files/upload-target
      x-source: https://docs.gadget.dev/guides/models/storing-files
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl https://my-gadget-app.gadget.app/api/files/upload-target Once you have a direct upload url , you must PUT the file's contents
          to the url . The url is signed for security and expires after 3 hours to avoid abuse. This means you can't just generate the url once
          and hardcode it in your code -- you must generate a new url for each upload by your form. Once the upload has been completed, use the
          t
  /api/graphql:
    get:
      operationId: get_api_graphql
      tags:
      - Api
      summary: GET /api/graphql
      x-source: https://docs.gadget.dev/guides/models/storing-files
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl according to the multipart request spec, you can run the following command: terminal Copy curl https://example.gadget.app/api/graphql  -F
          operations=''{ "query": "mutation ($file: Upload!) { createImage(image: { name: "A test image", image: { file: $file } } )) { success
          image { id image {url}} } }", "variables": { "file": null } }''  -F map=''{ "0": ["variables.file"] }''  -F [email protected] U'
    post:
      operationId: post_api_graphql
      tags:
      - Api
      summary: POST /api/graphql
      x-source: https://docs.gadget.dev/guides/frontend/external-frontends
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiGraphqlRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl command line utility: terminal Copy curl -X POST  -H "Content-Type: application/json"  -d ''{ "query": "query { gadgetMeta
          {name} }" }''  https://example-app.gadget.app/api/graphql Deploying and hosting external frontends   Frontends built using React or
          other client-side frameworks need to be deployed to a hosting provider. Gadget recommends using Vercel or Netlify for hosting your frontends, '
  /data:
    post:
      operationId: post_data
      tags:
      - Data
      summary: POST /data
      x-source: https://docs.gadget.dev/guides/tutorials/middleware
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostDataResponse'
      x-evidence:
        kind: code-example
        language: javascript
        snippet: "fetch(\"https://orders-request-bin.gadget.app/data\", {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\"\
          ,\n },\n body: JSON.stringify(record),\n })"
  /stores/${record.storeHash}/graphql:
    post:
      operationId: post_stores_record_storeHash_graphql
      tags:
      - Stores
      summary: POST /stores/${record.storeHash}/graphql
      x-source: https://docs.gadget.dev/guides/tutorials/bigcommerce/size-charts
      parameters:
      - name: record.storeHash
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: javascript
        snippet: "fetch(\n `https://api.bigcommerce.com/stores/${record.storeHash}/graphql`,\n {\n method: \"POST\",\n headers: {\n \"Content-Type\"\
          : \"application/json\",\n Accept: \"application/json\",\n \"X-Auth-Token\": store.accessToken,\n },\n body: JSON.stringify({\n query:\
          \ `mutation AppExtension($input: CreateAppExtensionInput!) {\n appExtension {\n createAppExtension(input: $input) {\n appExtension {\n\
          \ id\n context\n model\n url\n la"
  /inventory/{sku}:
    get:
      operationId: get_inventory_sku
      tags:
      - Inventory
      summary: HTTP route that retrieves inventory information for a product SKU.
      x-source: https://docs.gadget.dev/guides/development-tools/load-testing
      parameters:
      - name: sku
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInventorySkuResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostAdminApi202604GraphqlJsonRequest:
      type: object
      properties:
        query:
          type: string
    PostAdminApi202604GraphqlJsonResponse:
      type: object
      properties:
        shopDomain:
          type: object
          properties:
            type:
              type: string
    PostApiGraphqlRequest:
      type: object
      properties:
        query:
          type: string
    PostDataResponse:
      type: object
      properties:
        actionType:
          type: string
        triggers:
          type: object
          properties:
            api:
              type: boolean
    GetInventorySkuResponse:
      type: object
      properties:
        status:
          type: integer
          description: HTTP response status code
tags:
- name: Admin
- name: Api
- name: Data
- name: Inventory
- name: Stores