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

# Download all ECU map candidates

> Issue a fresh storage download for a completed inspection or map scan. Reads metadata only: it does not rerun analysis, fetch the internal envelope or regenerate the file. The downloaded body follows ecu_map_artifact. Existing file ownership, current key/subscription access and result expiry are checked before signing. A deleted or expired input does not prevent downloading a still-retained result. In the interactive playground or a browser client, set redirect=false to receive HTTP 200 JSON containing the short-lived storage URL, expiry and artifact manifest. Open that URL separately to download all maps. Automatic cross-origin redirects can fail browser CORS checks.



## OpenAPI

````yaml /openapi-v2.json get /ecu/jobs/{job_id}/artifacts/maps
openapi: 3.0.0
info:
  title: Remapdb API v2
  description: >-
    Vehicle Tuning Database API - For Tuning services and Tuners.


    Access comprehensive vehicle details, including types, manufacturers,
    models, engines, ECU and TCU info, tuning tools, dyno charts, and available
    tuning or remap stages with their performance gains.



    REST v2 uses the same Bearer API keys as v1. Account customizations apply
    only when the subscription has Customizations access. Cache catalog
    responses by API version, account, language and catalog profile, never by
    entity ID alone. IDs and cursors remain numeric and can exceed 32-bit
    integers; support integers through 9007199254740991. Identify stages by id,
    not stage_number. Manufacturer logos may be null; custom logos and
    generation photos use durable CDN object URLs. See
    https://docs.remapdb.com/api/migrate-to-v2.


    Private catalog slugs use rdb-brand-{id}, rdb-make-{id}, rdb-gen-{id}, and
    rdb-engine-{id}. Legacy rdb-private-{entity}-{id} links continue to resolve.


    Create and name up to 10 active key/secret pairs in API > API keys. All
    pairs share the same subscription and entitlements. Use only the key as the
    bearer token; this header does not require the secret. Rotation or
    revocation invalidates the selected key on subsequent requests, including
    existing MCP sessions. Other keys remain valid.


    Account activity is available in the Remapdb app under API > API usage.
    Request logging records account/key identifiers, normalized endpoint, status
    and duration; new logs exclude credential values and request payloads. See
    https://docs.remapdb.com/api/usage-and-monitoring.
  termsOfService: https://remapdb.com/terms
  contact:
    name: Remapdb.com
    url: https://remapdb.com
  version: 2.0.0
  x-logo:
    url: https://cdn.remapdb.com/logos/remapdb-logo-default-full-light.svg
    altText: Remapdb REST API Documentation
servers:
  - url: https://api.remapdb.com/v2
security:
  - bearerAuth: []
tags:
  - name: Response and Errors
    description: >-
      - API will always respond with json, content type: **application/json**.

      - Successfull response will return HTTP **2XX** ***(Success)*** response
      code.

      - Error response will return either HTTP **4XX** ***(Client Error)*** or
      HTTP **5XX** ***(Server Error)***.


      On error, API will return error object. It will contain the appropriate
      error **code** *(integer)* and a **message** *(string)*.

      The HTTP response code will be the same as the error code.


      Error Schema:

      ```json json_schema

      {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          }
        }
      }

      ```


      Error Example:

      ```json http

      {
        "code": 404,
        "message": "Method doesnt exist."
      }

      ```



      DTC and ECU endpoints instead use a structured `{error: {code: string,
      message: string}}` envelope; see their operation schemas.
    x-traitTag: true
  - name: Language
    description: >-
      All API methods accept custom language. It can be set via the
      **"Accept-Language"** header. Content of the header should be the code of
      the language you are requesting.


      #### Available languages:

      Code | Name

      ---------|----------
       `bg` | Bulgarian
       `da` | Danish
       `de` | German
       `en` | English **(default)**
       `es` | Spanish
       `et` | Estonian
       `fi` | Finnish
       `fr` | French
       `hr` | Croatian
       `hu` | Hungarian
       `it` | Italian
       `lt` | Lithuanian
       `lv` | Latvian
       `nb` | Norwegian Bokmål
       `nl` | Dutch
       `nn` | Norwegian Nynorsk
       `pt` | Portuguese
       `ru` | Russian
       `sv` | Swedish
       `tr` | Turkish
       `zs` | Chinese

      If no "accept-language" header is set, the API will use the default
      language - English.


      Following example shows how to set the language to Dutch (`nl`) using
      curl:

      ```json http

      curl 'https://api.remapdb.com/v1/search?query=audi' \

      --header 'Accept-Language: nl'

      ```



      DTC dictionary descriptions are returned as stored and are not translated.
    x-traitTag: true
  - name: Rate Limits
    description: >-
      All active API keys on an account share one request allowance across REST
      v1, REST v2 and MCP. The standard allowance is 120 requests per minute.
      Creating or rotating keys does not reset it. API v2 returns HTTP 429 when
      the limit is reached; retry after the current minute window. UK lookup
      credits and ECU job/storage quotas are also shared by the account.
    x-traitTag: true
  - name: Client SDKs
    description: >
      Remapdb offers OpenAPI v3 specification which can be used with any
      OpenAPI/Swagger client generator to generate your own client SDK.

      Download OpenAPI specification:
      [https://docs.remapdb.com/openapi.json](https://docs.remapdb.com/openapi.json).



      Following SDK's are automatically generated:

      Language | Link

      ----------|----------

      PHP |
      [https://github.com/remapdb-api/remapdb-php-sdk](https://github.com/remapdb-api/remapdb-php-sdk)

      JavaScript |
      [https://github.com/remapdb-api/remapdb-js-sdk](https://github.com/remapdb-api/remapdb-js-sdk)
    x-traitTag: true
  - name: Subscription
    description: >
      Most of the API methods require an active API subscription. The following
      method allows you to obtain information about your current API
      subscription.


      More info about Remapdb's API subscription can be found here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)
    x-displayName: API Subscription
  - name: Types
    description: >
      Obtain information about the vehicle types. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**
    x-displayName: Vehicle Types
  - name: Manufacturers
    description: >
      Obtain information about vehicle manufacturers. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**
  - name: Models
    description: >
      Obtain information about vehicle models. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**
  - name: Generations
    description: >
      Obtain information about model generations. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**      
  - name: Engines
    description: >
      Obtain information about vehicle engines. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**     
  - name: Search
    description: >
      Searches through manufacturers, models, generations and engines. 


      **Active API subscription required. Get it here:
      [https://app.remapdb.com/api](https://app.remapdb.com/api)**
  - name: VRM lookup
    description: >-
      Ordinary UK VRM lookup requires an active API or MAX full API
      subscription, vdb_read scope and VRM entitlement. Designated saved test
      registrations are free through REST on every plan with a valid scoped API
      key, including trials. Widgets have separate access: Free accounts can use
      purchased credits with zero included allowance.
  - name: ECU observation
    description: >-
      Controlled-access, observation-only binary analysis under /ecu/. Jobs are
      asynchronous; reports are concise and account-scoped.
  - name: DTC lookup
    description: >-
      Synchronous diagnostic-code dictionary lookup included with every active
      API or MAX full API subscription. Requires vdb_read. No worker, lookup
      credits or ECU rollout access required. Descriptions are stored reference
      text, not diagnosis or verified vehicle applicability; not translated by
      Accept-Language.
paths:
  /ecu/jobs/{job_id}/artifacts/maps:
    get:
      tags:
        - ECU observation
      summary: Download all ECU map candidates
      description: >-
        Issue a fresh storage download for a completed inspection or map scan.
        Reads metadata only: it does not rerun analysis, fetch the internal
        envelope or regenerate the file. The downloaded body follows
        ecu_map_artifact. Existing file ownership, current key/subscription
        access and result expiry are checked before signing. A deleted or
        expired input does not prevent downloading a still-retained result. In
        the interactive playground or a browser client, set redirect=false to
        receive HTTP 200 JSON containing the short-lived storage URL, expiry and
        artifact manifest. Open that URL separately to download all maps.
        Automatic cross-origin redirects can fail browser CORS checks.
      operationId: download_ecu_maps
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Opaque account-owned identifier.
        - name: redirect
          in: query
          description: >-
            Set false in the interactive playground and browser clients to
            receive a JSON download link without a redirect. Omit or set true
            for the existing HTTP 302 download behavior.
          schema:
            type: boolean
            default: true
          example: false
      responses:
        '200':
          description: >-
            When redirect=false: a short-lived storage URL and manifest. Open
            url separately or fetch it without API credentials or cookies. The
            API returns metadata only, not the map list.
          headers:
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
            Referrer-Policy:
              schema:
                type: string
                enum:
                  - no-referrer
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  url:
                    type: string
                    format: uri
                    description: >-
                      Short-lived signed storage URL. Use immediately without
                      the API Authorization header.
                  expires_at:
                    type: string
                    format: date-time
                  artifact:
                    $ref: '#/components/schemas/ecu_map_artifact_metadata'
                required:
                  - url
                  - expires_at
                  - artifact
        '302':
          description: >-
            Authorized download. Follow Location using a GET with no API
            Authorization header. Storage serves gzip-encoded application/json
            with Content-Disposition: attachment. Browser clients require
            storage CORS for their origin. The signed URL expires within 60
            seconds or at result expiry, whichever is sooner; it can be reused
            until then, even if the API key is revoked after issuance.
          headers:
            Location:
              schema:
                type: string
                format: uri
              description: Short-lived bearer URL to the private public-map artifact.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
            Referrer-Policy:
              schema:
                type: string
                enum:
                  - no-referrer
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  expires_at:
                    type: string
                    format: date-time
                  artifact:
                    $ref: '#/components/schemas/ecu_map_artifact_metadata'
                required:
                  - expires_at
                  - artifact
        '400':
          $ref: '#/components/responses/ecu_error_400'
        '401':
          $ref: '#/components/responses/ecu_error_401'
        '403':
          $ref: '#/components/responses/ecu_error_403'
        '404':
          description: >-
            Job not found for this account, or artifact_unavailable for an
            older/non-map job. Older jobs still support paginated details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ecu_error'
        '405':
          $ref: '#/components/responses/ecu_error_405'
        '409':
          $ref: '#/components/responses/ecu_error_409'
        '410':
          $ref: '#/components/responses/ecu_error_410'
        '429':
          $ref: '#/components/responses/ecu_error_429'
        '503':
          $ref: '#/components/responses/ecu_error_503'
components:
  schemas:
    ecu_map_artifact_metadata:
      type: object
      additionalProperties: false
      properties:
        schema_version:
          type: string
          enum:
            - remapdb.ecu.maps.v1
        download_url:
          type: string
          description: >-
            Stable authenticated API endpoint. Returns a 302 redirect to a fresh
            signed storage URL. Never send your API token to the redirect
            destination.
        media_type:
          type: string
          enum:
            - application/json
        content_encoding:
          type: string
          enum:
            - gzip
        map_count:
          type: integer
          minimum: 0
        size_bytes:
          type: integer
          minimum: 0
          maximum: 16777216
          description: Exact decoded UTF-8 JSON bytes, after HTTP gzip decompression.
        compressed_size_bytes:
          type: integer
          minimum: 0
        sha256:
          type: string
          pattern: ^[a-f0-9]{64}$
          description: SHA-256 of the decoded JSON bytes, not the gzip container.
      required:
        - schema_version
        - download_url
        - media_type
        - content_encoding
        - map_count
        - size_bytes
        - compressed_size_bytes
        - sha256
      description: >-
        Immutable public map artifact generated once by the worker, retained
        until the parent job expires. Missing on older jobs. Contains
        descriptors, not all grid cell values.
    ecu_error:
      type: object
      additionalProperties: false
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                Stable ECU error reason, including authentication and
                request-rate failures.
            message:
              type: string
      required:
        - error
  responses:
    ecu_error_400:
      description: Invalid request body, parameters or Idempotency-Key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ecu_error'
    ecu_error_401:
      description: Missing or invalid API credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ecu_error'
    ecu_error_403:
      description: ECU observation is not enabled for this account or access is denied.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ecu_error'
    ecu_error_405:
      description: HTTP method not supported by this endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ecu_error'
    ecu_error_409:
      description: Job not complete, stale scan binding or conflicting Idempotency-Key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ecu_error'
    ecu_error_410:
      description: File or result has expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ecu_error'
    ecu_error_429:
      description: >-
        Request-rate or ECU processing quota exceeded. Follow Retry-After when
        present.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ecu_error'
      headers:
        Retry-After:
          description: Suggested delay in seconds when supplied.
          schema:
            type: integer
            minimum: 1
    ecu_error_503:
      description: Observation service temporarily unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ecu_error'
      headers:
        Retry-After:
          description: Suggested delay in seconds when supplied.
          schema:
            type: integer
            minimum: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: |-
        All API methods require Bearer authentication.
        Use your existing API key as the bearer token.

        Authorization header format: `Authorization: Bearer YOUR_API_KEY`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.